Skip to main content
GET
/
forms
List forms
curl --request GET \
  --url https://app.azalt.co/api/v1/forms \
  --header 'Authorization: Bearer <token>'
[
  {
    "formId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "isPublic": true,
    "tags": [
      "<string>"
    ],
    "totalElements": 123,
    "totalPossibleDataPoints": 123,
    "formSites": [
      {
        "formSiteId": "<string>",
        "siteId": "<string>",
        "siteName": "<string>",
        "year": 123,
        "submissionCount": 123,
        "dataCount": 123,
        "filledElements": 123,
        "activityCount": 123,
        "progress": 123
      }
    ],
    "overallProgress": 123,
    "totalSubmissions": 123,
    "totalDataCount": 123,
    "years": [
      123
    ],
    "sites": [
      "<string>"
    ],
    "yearsText": "<string>",
    "sitesText": "<string>",
    "yearsMoreCount": 123,
    "sitesMoreCount": 123,
    "assignments": [
      {
        "id": "<string>",
        "organizationUserId": "<string>",
        "createdAt": "<string>",
        "userId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "image": "<string>",
        "role": "<string>",
        "accessibleSiteIds": [
          "<string>"
        ]
      }
    ],
    "metadata": "<unknown>",
    "settings": "<unknown>"
  }
]

Authorizations

Authorization
string
header
required

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

Response

Successful response

formId
string
required
name
string
required
description
string | null
required
isPublic
boolean
required
tags
string[]
required
totalElements
number
required
totalPossibleDataPoints
number
required
formSites
object[]
required
overallProgress
number
required
totalSubmissions
number
required
totalDataCount
number
required
years
number[]
required
sites
string[]
required
yearsText
string
required
sitesText
string
required
yearsMoreCount
number
required
sitesMoreCount
number
required
assignments
object[]
required
metadata
any
settings
unknown