List partner venues

Returns the venues the authenticated partner is scoped to. Call this at onboarding to learn your venue scope. The IDs returned here are what you use as {venueId} everywhere else.

GET /v1/pat/venues
Authorization: Bearer <token>

Query parameters

Pagination and filtering follow the standard Mozrest list convention: offset + limit, filters[...], and a total in the response.

Name	Type	Default	Notes
offset	integer	0	Number of venues to skip.
limit	integer	10	Page size. Maximum 100.
filters[name]	string	-	Partial, case-insensitive match on the venue name.
filters[city]	string	-	Partial, case-insensitive match on the venue city.
filters[countryCode]	string	-	Exact ISO 3166-1 alpha-2 match (e.g. FR, GB).

curl -G "https://api-sandbox.mozrest.com/v1/pat/venues" \
  -H "Authorization: Bearer $TOKEN" \
  -d "offset=0" \
  -d "limit=25" \
  -d "filters[countryCode]=FR" \
  -d "filters[city]=Paris" \
  -d "filters[name]=Comptoir"

Response - 200 OK

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

Field	Notes
total	Number of venues matching the filters across all pages - use it to drive pagination; it ignores offset/limit.
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.
city	Venue city. null if not set on the venue.
timezone	IANA timezone (e.g. Europe/Paris). null if not set on the venue.
posCode	Family code of the venue's currently active POS (e.g. MOZREST_POS, SIMPHONY). null if the venue has no active POS configured - in that case the per-venue Pay-at-Table endpoints will return 404.

To fetch your full scope, page with offset (0, 10, 20, …) until you have collected total venues - or pass a larger limit (up to 100) to do it in fewer calls.

total: 0 means the token is valid but no venues match - with no filters, none are currently scoped to your partner. Contact support@mozrest.com if you expected venues here.

Errors

Status	When
401 Unauthorized	Token invalid or revoked. OAuth-style body, not the standard envelope - see Errors
403 Forbidden	Missing Authorization header, or token does not have partner access