Docs

Get Advances

GET /advances

GET/advances

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Returns all advances for the event. An advance is a formal process for collecting and organizing show information for a collaborator — it may be sent out for the collaborator to fill in, or used internally to document and log details. Each advance is linked to a collaborator and optionally an area and activity, and is made up of question blocks (for gathering information) and request blocks (for resource requests), each tracking their approval status and any linked asset.

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.

Response Fields

FieldTypeDescription
idGuidThe advance's unique ID.
namestringDisplay name of the advance.
collaboratorobjectThe collaborator this advance belongs to, including their point-of-contact crew members.
areaobject \| nullnull
activityobject \| nullnull
questionsarrayAnswered question blocks on this advance. Each entry includes the module, template block, and current value.
requestsarrayResource request blocks on this advance. Each entry includes approval status, linked asset (if fulfilled), and any properties.

Example Response

[
  {
    "id": "adv-guid-001",
    "name": "Stage A Advance",
    "collaborator": {
      "id": "collab-guid-001",
      "name": "Stage Productions Inc.",
      "contacts": [
        {
          "id": "crew-guid-001",
          "firstName": "Jane",
          "lastName": "Smith",
          "title": "Production Manager",
          "email": "jane@stageproductions.com",
          "phone": "555-0100"
        }
      ]
    },
    "area": { "id": "area-guid-001", "name": "Main Stage" },
    "activity": {
      "id": "act-guid-001",
      "name": "Soundcheck",
      "startTime": "2026-06-15T14:00:00Z",
      "endTime": "2026-06-15T16:00:00Z"
    },
    "questions": [
      {
        "id": "q-guid-001",
        "advanceModuleId": "mod-guid-001",
        "moduleTemplateBlockId": "block-guid-001",
        "questionTemplateId": "qtmpl-guid-001",
        "value": "Yes"
      }
    ],
    "requests": [
      {
        "id": "req-guid-001",
        "advanceModuleId": "mod-guid-001",
        "moduleTemplateBlockId": "block-guid-002",
        "requestTemplateId": "rtmpl-guid-001",
        "advanceApproved": true,
        "resourceApproved": null,
        "asset": null,
        "properties": []
      }
    ]
  }
]

Error Codes

CodeHTTP StatusDescription
UNAUTHORIZED401Missing or invalid token.