Skip to content

Venues

List the venues your API key is allowed to operate. You do not need ids emailed to you.

Auth: x-api-key. Scope is always the partner that key resolves to.

List

http
GET /api/v1/partner/venues
x-api-key: <your-api-key>
json
{
  "success": true,
  "count": 1,
  "data": [
    {
      "venue_id": "a0000000-0000-4000-8000-000000000001",
      "name": "Sandbox Venue A",
      "address": "…",
      "city": "…",
      "status": "active"
    }
  ]
}

No grants yet: 200 with "data": []. That is the waiting-for-onboarding state.

There is no pagination today. If it is added, it will be additive.

Get one

http
GET /api/v1/partner/venues/{venueId}
x-api-key: <your-api-key>

A missing id and an id that exists but is not granted both return 404 VENUE_NOT_FOUND. The two cases are deliberately indistinguishable.

Next

Resources at that venue_id.

Start in the sandbox. Production access is granted after certification.