Docs
Get Advance Request
GET /advanceRequests/{advanceRequestId}
GET
/advanceRequests/{advanceRequestId}Required 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. |
Returns detailed information for a single advance request. Compared to the list endpoint, this response includes the full request template definition — including all its properties with labels and response types — making it suitable for rendering an approval detail view.
Event scoping: These endpoints do not include {eventId} in the URL. The event is determined automatically from your x-Event-Token — the API uses it to know which event's
data to return. Ensure you have a valid event token before making any calls in this folder.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| advanceRequestId | Guid | Required | The ID of the advance request to retrieve. |
Response Fields
| Field | Type | Description |
|---|---|---|
| id | Guid | The advance request's unique ID. |
| advanceApproved | bool \| null | null |
| resourceApproved | bool \| null | null |
| procurementId | Guid \| null | null |
| advance | object | Parent advance with collaborator, area, and activity. |
| module | object | The advance module instance (id, label, icon from its template). |
| moduleTemplateBlock | object | The specific block (id). |
| requestTemplate | object | Full request template definition including `isAssetRequest`, approval flags, and all property definitions with labels and response types. |
| asset | object \| null | null |
| properties | array | Current property values for this request. |
Example Response
{
"id": "req-guid-001",
"advanceApproved": true,
"resourceApproved": null,
"procurementId": null,
"advance": {
"id": "adv-guid-001",
"name": "Stage A Advance",
"collaborator": { "id": "collab-guid-001", "name": "Stage Productions Inc." },
"area": { "id": "area-guid-001", "name": "Main Stage" },
"activity": null
},
"module": { "id": "advmod-guid-001", "label": "Audio", "icon": "speaker" },
"moduleTemplateBlock": { "id": "block-guid-001" },
"requestTemplate": {
"id": "rtmpl-guid-001",
"name": "PA System",
"isAssetRequest": true,
"isAdvanceApproved": false,
"isResourceApproved": false,
"properties": [
{
"id": "tprop-guid-001",
"label": "Number of Channels",
"responseType": "Number"
}
]
},
"asset": null,
"properties": [{ "id": "prop-guid-001", "templatePropertyId": "tprop-guid-001", "value": "12" }]
}
Error Codes
| Code | HTTP Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid token. |
NOT_FOUND | 404 | Advance request not found for this event. |