Skip to main content
GET
/
forms
/
{id}
Get form
curl --request GET \
  --url https://app.azalt.co/api/v1/forms/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "isPublic": true,
  "formSites": [
    {
      "id": "<string>",
      "siteId": "<string>",
      "year": 123
    }
  ],
  "elements": [
    {
      "id": "<string>",
      "key": "<string>",
      "label": "<string>",
      "required": true,
      "options": [
        {
          "label": "<string>",
          "value": "<string>",
          "description": "<string>",
          "points": 123,
          "actionText": "<string>"
        }
      ],
      "parentElementId": "<string>",
      "type": "NUMBER",
      "unitId": "<string>",
      "period": "MONTHLY",
      "order": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "deletedAt": "<string>",
      "activityDefinitionId": "<string>",
      "distributionMode": "<string>",
      "formId": "<string>",
      "unitName": "<string>",
      "metadata": {},
      "conditions": null,
      "config": null,
      "schedule": {
        "dataEntry": {
          "dueDate": {
            "type": "fixed-day",
            "day": 16,
            "timing": "current-period"
          },
          "reminders": {
            "enabled": true,
            "offsets": [
              {
                "type": "days-before",
                "days": 15
              }
            ]
          }
        },
        "approval": {
          "dueDate": {
            "type": "fixed-day",
            "day": 16,
            "timing": "current-period"
          },
          "reminders": {
            "enabled": true,
            "offsets": [
              {
                "type": "days-before",
                "days": 15
              }
            ]
          }
        }
      }
    }
  ],
  "years": [
    "<string>"
  ],
  "sites": [
    "<string>"
  ],
  "metadata": null,
  "settings": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.azalt.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

Successful response

id
string
required
name
string
required
description
string | null
required
isPublic
boolean
required
formSites
object[]
required
elements
object[]
required
years
string[]
required
sites
(string | null)[]
required
metadata
unknown
settings
unknown