Get form submissions
FormSubmission
Get form submissions
Retrieve form submissions with flexible identification options:
Form Identification (choose one):
formId: Direct form ID (e.g., “form-abc123”)formMetadataKey+formMetadataValue: Lookup by metadata (e.g., “erpFormId” = “form123”)
Optional Site Filtering:
siteId: Filter by specific site IDsiteMetadataKey+siteMetadataValue: Filter by site metadatayear: Filter by specific year
You can identify forms using either internal IDs or custom metadata key-value pairs, making it easy to integrate with external systems.
Response shape notes:
- Each submission contains
valuesgrouped by (elementId, periodUnit). - When a cell has multiple entries (e.g., TIMESTAMP elements with multiple timepoints in the same month, or ACTIVITY outputs),
valuebecomes an array. Each array item includes:recordedAt(for TIMESTAMP entries),formElementSubmissionId,status, anddocs(supporting documents) for that specific row.
- For single entries,
valueis the scalar value.
Example response (trimmed):
[
{
"id": "fs-1",
"year": 2024,
"values": [
{ "elementId": "el-monthly", "periodUnit": 3, "value": 120.5, "status": "APPROVED" },
{ "elementId": "el-ts", "periodUnit": 3, "value": [
{ "value": 10, "recordedAt": "2024-03-05T10:30:00Z", "formElementSubmissionId": "fes-1", "status": "COMPLETED", "docs": [] },
{ "value": 15, "recordedAt": "2024-03-12T08:00:00Z", "formElementSubmissionId": "fes-2", "status": "APPROVED", "docs": [] }
]
}
]
}
]
GET
Get form submissions
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Available options:
full, summary Response
Successful response

