Docs
Get Advance Forms
GET /collaborators/{collaboratorId}/advanceForms
GET
/collaborators/{collaboratorId}/advanceFormsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns the full advance form data for a collaborator, including all modules, question responses, and resource request responses. This is the complete data view used for filling out or reviewing advances.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The ID of the collaborator. |
Response
Returns an array of advance objects. Each advance contains:
| Field | Type | Description |
|---|---|---|
| id | Guid | Advance ID. |
| name | string | Advance name. |
| area | object | Associated area (`{ id, name }`). |
| activity | object | Associated activity (`{ id, name, startTime, endTime }`). |
| modules | Module[] | Advance modules with full template block detail. |
| modules[].id | Guid | Module instance ID. |
| modules[].index | int | Sort order. |
| modules[].dueDate | DateTime | Module due date. |
| modules[].isRequired | bool | Whether completion is required. |
| modules[].isTaskTracked | bool | Whether module progress is tracked via tasks. |
| modules[].moduleTemplate | object | Module template details including blocks (questions, requests, content). |
| questions | Question[] | Submitted question responses. |
| questions[].id | Guid | Response ID. |
| questions[].advanceModuleId | Guid | Parent module ID. |
| questions[].moduleTemplateBlockId | Guid | Block this response answers. |
| questions[].questionTemplateId | Guid | Question template ID. |
| questions[].taskId | Guid | Associated task ID. |
| questions[].taskStatusId | Guid | Task status ID. |
| questions[].value | string | The response value. |
| requests | Request[] | Submitted resource request responses with asset and property data. |