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,
    "updatedAt": "<string>",
    "tags": [
      "<string>"
    ],
    "totalElements": 123,
    "totalPossibleDataPoints": 123,
    "totalExpectedDataPoints": 123,
    "totalActivityCount": 123,
    "formSiteCount": 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>",
    "siteSearchText": "<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": null
  }
]

Form

List forms

Retrieve all forms accessible to the authenticated user within their organization and site permissions.

Optional Filtering:

siteId: Filter forms available for a specific site
year: Filter forms configured for a particular year
status: Filter by form status (active, draft, archived)

Response includes:

Form summaries with basic metadata
Element counts and types overview
Site associations and deployment status
Creation and modification timestamps
Public access configuration
Submission statistics and completion rates

Form Categories:

Environmental Data Collection: Energy, water, waste, emissions
Compliance Reporting: Regulatory requirements, certifications
Sustainability Surveys: ESG data, supplier assessments
Operational Metrics: Facility data, resource consumption

Use Cases:

Dashboard and admin interface population
Form selection for data entry workflows
Reporting and analytics preparation
Audit trail and compliance documentation

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,
    "updatedAt": "<string>",
    "tags": [
      "<string>"
    ],
    "totalElements": 123,
    "totalPossibleDataPoints": 123,
    "totalExpectedDataPoints": 123,
    "totalActivityCount": 123,
    "formSiteCount": 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>",
    "siteSearchText": "<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": null
  }
]

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

updatedAt

string | null

required