Docs
Get Area Advances
GET /Areas/{areaId}/advances
GET
/Areas/{areaId}/advancesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
| Area token | x-Area-Token | Optional | Run **Get Tokens** with `areaId` set in your environment, or call `GET /Areas/{areaId}/authorize` with your event token. |
Returns all advances associated with this area, including collaborator point-of-contact details, linked activity, and the full advance content (questions, requests, and assets).
Requires EventAdmin permission on the event.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| areaId | Guid | Required | The ID of the area. |
Response
Returns an array of advance objects.
Advance Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Advance ID. |
| name | string | Advance name. |
| collaborator | object | The collaborator this advance belongs to. |
| activity | object | The activity this advance is linked to, if any. |
| questions | array | Question responses on this advance. |
| requests | array | Resource requests on this advance. |
Collaborator Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Collaborator ID. |
| name | string | Collaborator name. |
| contacts | array | Point-of-contact entries for this collaborator. |
Contact Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Contact ID. |
| firstName | string | First name. |
| lastName | string | Last name. |
| title | string | Job title. |
| string | Email address. | |
| phone | string | Phone number. |
Activity Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Activity ID. |
| name | string | Activity name. |
| startTime | DateTime | Activity start time (UTC). |
| endTime | DateTime | Activity end time (UTC). |
Question Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Question response ID. |
| advanceModuleId | Guid | ID of the advance module this question belongs to. |
| moduleTemplateBlockId | Guid | Template block ID. |
| questionTemplateId | Guid | Question template ID. |
| value | string | The answered value. |
Request Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Request ID. |
| advanceModuleId | Guid | ID of the advance module this request belongs to. |
| moduleTemplateBlockId | Guid | Template block ID. |
| requestTemplateId | Guid | Request template ID. |
| advanceApproved | bool | Whether the advance team has approved this request. |
| resourceApproved | bool | Whether the resource team has approved this request. |
| asset | object | The asset associated with this request, if any. |
| properties | array | Additional property values on this request (`id`, `templatePropertyId`, `value`). |
Asset Object
| Field | Type | Description |
|---|---|---|
| id | Guid | Asset ID. |
| type | object | Asset type definition (id, label, icon, lineItemLabel). |
| subAssets | array | Child assets, each with their own `properties` array. |
| properties | array | Property values on the asset (`id`, `templatePropertyId`, `value`). |