Docs

Get Dashboard

GET /Events/{eventId}/dashboard

GET/Events/{eventId}/dashboard

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 a summary view of the event, including its collaborators, areas, point-of-contact crew members, and notes. This is the primary overview endpoint for an event.

Path Parameters

FieldTypeRequiredDescription
eventIdGuidRequiredThe ID of the event.

Example Response

{
  "name": "Summer Festival 2026",
  "location": "Riverside Amphitheater",
  "notes": "Load-in begins at 8am. Confirm with venue by Friday.",
  "collaborators": [
    { "id": "0197f069-bd91-76c8-bfd0-5e287b932da7", "name": "Production Co." },
    { "id": "0197f069-bd91-76c8-bfd0-5e287b932da8", "name": "Catering Inc." }
  ],
  "areas": [
    { "id": "0197f06d-7593-72af-ae45-f5e012fbad50", "name": "Main Stage" },
    { "id": "0197f06d-7593-72af-ae45-f5e012fbad51", "name": "VIP Lounge" }
  ],
  "contacts": [
    {
      "id": "crew-guid-001",
      "firstName": "Jane",
      "lastName": "Smith",
      "title": "Site Manager",
      "email": "jane@productioncо.com",
      "phone": "+1-555-0100"
    }
  ]
}

Error Codes

CodeHTTP StatusDescription
UNAUTHORIZED401Missing or invalid token.
NOT_FOUND404Event not found.