List partner venues

Returns the venues the authenticated partner is scoped to. Call this once at onboarding to learn your venue scope, and periodically afterwards to pick up newly added venues. The IDs returned here are what you use as {venueId} everywhere else.

GET /v1/pos/partner/venues
Authorization: Bearer <token>

Only venues currently available for analytics queries are returned. If a venue is in your partner scope but temporarily not available (for example, while it's being onboarded or after a configuration change), it is omitted from the list rather than returned with a degraded state.

Path parameters

None.

Response — 200 OK

{
  "venues": [
    {
      "id": "651f2c781027817e9f28e465",
      "name": "Le Comptoir",
      "country": "FR",
      "timezone": "Europe/Paris"
    }
  ]
}

Field	Notes
id	Mozrest canonical venue ID. Use this as {venueId} on every other endpoint.
name	Human-readable venue label. May change without breaking id.
country	ISO 3166-1 alpha-2 country code. null if not set on the venue.
timezone	IANA timezone (e.g. Europe/Paris). null if not set on the venue.

An empty venues array means the token is valid but no venues are currently scoped to its partner. Contact support@mozrest.com if you expected venues here.

Errors

Status	When
401 Unauthorized	Missing or invalid Authorization header
403 Forbidden	Token does not have partner access