GET /Forms
Default limit is 200 items.
| Parameter | Default | Description |
|---|---|---|
limit | 200 | Items per page |
page | 0 | Pagination offset |
fromDate | - | Forms with CreatedDate >= value. Format: YYYY-MM-DD |
toDate | - | Forms with CreatedDate <= value. Format: YYYY-MM-DD |
carerId | - | Filter by carer ID. Parameter names are case-sensitive: CarerId is silently ignored |
clientId | - | Filter by client ID |
templateId | - | Filter by template ID |
| Field | Type | Notes |
|---|---|---|
FormId | integer | |
FormName | string | |
TemplateId | integer | |
AssignedTo | string | |
CreatedBy | string | |
CreatedDate | string | Datetime |
FormDate | string | Datetime. 0000-00-00 00:00:00 when not set |
ReviewDate | string | Datetime |
CompletedDate | string | Datetime |
Status | string | |
ClientId | string | Numeric string |
LeadId | integer | |
CarerId | integer | |
LocationId | integer | |
vis_sw_mob | integer | 0/1 |
vis_cl_mob | integer | 0/1 |
RosterItemId | integer | |
TimeSheetId | integer | |
SubmissionId | string | Numeric string |
FormData | object/null | Nested form submission data. null when the form has no submission |
| Field | Type | Notes |
|---|---|---|
id | string | Numeric string |
ip | string | |
new | string | Numeric string |
flag | string | Numeric string |
notes | string | |
status | string | for example "ACTIVE" |
form_id | string | Numeric string |
created_at | string | Datetime |
updated_at | string | Datetime |
answers | object | Keyed by question ID. Each value has name, text, type, order and, when answered, answer |
