List sites

get/v1/sites

Sites in the org, sorted by name. Supports q typeahead (dashboard scope picker).

curl "https://api.vojo-media.com/v1/sites" \
  -H "Authorization: Bearer $VOJO_KEY"

// Lists are capped at 100 a page. listAll follows the cursor for you.
for await (const item of listAll((cursor) =>
  api.GET("/v1/sites", { params: { query: { cursor, limit: 100 } } }),
)) {
  console.log(item);
}

Response 200

{
  "data": [
    {
      "id": "cm1sit5r9j0001p3l7v2x8c4qd",
      "name": "Leeds Trinity",
      "address": {
        "street": "1 Market Street",
        "line_two": null,
        "city": "Leeds",
        "state": "West Yorkshire",
        "postal_code": "LS1 6DT",
        "country": "GB",
        "latitude": 53.7966,
        "longitude": -1.5432
      },
      "operating_times_enabled": true,
      "operating_times": {
        "monday": {
          "operational": true,
          "ranges": [
            {
              "start": "07:00",
              "end": "22:00"
            }
          ]
        },
        "tuesday": {
          "operational": true,
          "ranges": [
            {
              "start": "07:00",
              "end": "22:00"
            }
          ]
        },
        "wednesday": {
          "operational": true,
          "ranges": [
            {
              "start": "07:00",
              "end": "22:00"
            }
          ]
        },
        "thursday": {
          "operational": true,
          "ranges": [
            {
              "start": "07:00",
              "end": "22:00"
            }
          ]
        },
        "friday": {
          "operational": true,
          "ranges": [
            {
              "start": "07:00",
              "end": "22:00"
            }
          ]
        },
        "saturday": {
          "operational": true,
          "ranges": [
            {
              "start": "07:00",
              "end": "22:00"
            }
          ]
        },
        "sunday": {
          "operational": false,
          "ranges": []
        }
      },
      "created_at": "2025-04-11T12:00:00Z",
      "updated_at": "2026-10-07T09:30:00Z"
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6ImNtMXNjcjJ3Nm4wMDAxIn0",
    "has_more": true
  }
}

Access

Authentication: Secret key or OAuth access token.
Scope: sites:read
User permission: sitesAccessPage

Query parameters

qstring
Case-insensitive substring search on the resource name (typeahead).
1 to 100 characters
cursorstring
Opaque cursor from a previous response's meta.next_cursor. Omit for the first page.
limitinteger
Page size, 1-100. Default 25. A value outside 1-100, or not an integer, is rejected with 400 invalid_request (it is not clamped).
1 to 100
Default 25

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date

Response 200

dataarray of objectsRequired
Show 7 fields
- idstringRequired
  Site id. Opaque string — treat as an identifier, never parse it.
- namestringRequired
- addressobject or nullRequired
  Postal address and coordinates.
  Show 8 fields
  - streetstring or nullRequired
  - line_twostring or nullRequired
  - citystring or nullRequired
  - statestring or nullRequired
  - postal_codestring or nullRequired
  - countrystring or nullRequired
    ISO 3166-1 alpha-2 preferred.
  - latitudenumber or nullRequired
    -90 to 90
  - longitudenumber or nullRequired
    -180 to 180
- operating_times_enabledbooleanRequired
  Whether operating_times is enforced (screens outside hours are expected off).
- operating_timesobject or nullRequired
  Weekly operating hours. Each day carries an array of open windows (multi-range).
  Show 7 fields
  - mondayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
  - tuesdayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
  - wednesdayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
  - thursdayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
  - fridayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
  - saturdayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
  - sundayobjectRequired
    Show 2 fields
    operationalbooleanRequired
    False = closed all day.
    rangesarray of objectsRequired
    Zero or more open windows. A day can have several (multi-range).
    Show 2 fields
    startstringRequired
    Opening time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
    endstringRequired
    Closing time, 24-hour HH:MM.
    matches ^([01]\d|2[0-3]):[0-5]\d$
- created_atstringRequired
  RFC 3339 / ISO-8601 UTC timestamp.
  date-time
- updated_atstring or nullRequired
  RFC 3339 / ISO-8601 UTC timestamp, or null.
  date-time
metaobjectRequired
Pagination metadata for cursor-paginated lists.
Show 2 fields
- next_cursorstring or nullRequired
  Opaque cursor for the next page. Pass it back as cursor. null when there are no more results.
- has_morebooleanRequired
  True when another page exists (equivalent to next_cursor != null).

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
422
Well-formed request that failed validation. errors[] lists each failing field.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.