Docs
Get Advance
GET /collaborators/{collaboratorId}/advances/{advanceId}
GET
/collaborators/{collaboratorId}/advances/{advanceId}Required 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 configuration detail for a specific advance assigned to a collaborator, including its modules and their template metadata.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The ID of the collaborator. |
| advanceId | Guid | Required | The ID of the advance. Set `{{advanceId}}` in your environment. |
Response
| 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 | ModuleObj[] | Configured modules for this advance. |
| 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 tracked via tasks. |
| modules[].module | object | Template info (`{ id, name, label, icon }`). |