Skip to main content
GET
/
v1
/
venues
curl https://api.saoma.io/v1/venues \
  -H "Authorization: Bearer $SAOMA_API_KEY"
{
  "data": [
    {
      "id": "8f1a9c3b-8d4e-4f21-a1b2-c3d4e5f60718",
      "slug": "akasha-lutetia",
      "name": "Spa Akasha — Hôtel Lutetia",
      "name_en": "Akasha Spa — Hotel Lutetia",
      "image": "https://xfkujlgettlxdgrnqluw.supabase.co/storage/v1/object/public/venues/akasha.jpg",
      "cover_image": "https://xfkujlgettlxdgrnqluw.supabase.co/storage/v1/object/public/venues/akasha-cover.jpg",
      "address": "45 Boulevard Raspail",
      "postal_code": "75006",
      "city": "Paris",
      "country": "FR",
      "currency": "EUR",
      "venue_type": "hotel",
      "description": "Un sanctuaire de bien-être au cœur du 6ᵉ arrondissement.",
      "description_en": "A wellness sanctuary in the heart of the 6th arrondissement.",
      "timezone": "Europe/Paris"
    }
  ]
}
Returns the active venues that are in scope for your API key. Requires the venues:read scope.
If your API key is scoped to a single venue, this endpoint returns only that venue. Platform-wide keys receive every active venue, ordered by name.
This endpoint takes no query parameters and is not paginated — it returns the full in-scope list in one call. Cache the result; venue metadata changes rarely. Each venue exposes a slug (URL-safe, unique per organization) which you can use as the path identifier in any other endpoint — for example /v1/venues/akasha-lutetia/customers instead of the UUID form. The UUID id remains stable and accepted everywhere.

Response

data
Venue[]
Array of Venue objects (list shape — see the Venue concept for the exact fields).

Example

curl https://api.saoma.io/v1/venues \
  -H "Authorization: Bearer $SAOMA_API_KEY"
{
  "data": [
    {
      "id": "8f1a9c3b-8d4e-4f21-a1b2-c3d4e5f60718",
      "slug": "akasha-lutetia",
      "name": "Spa Akasha — Hôtel Lutetia",
      "name_en": "Akasha Spa — Hotel Lutetia",
      "image": "https://xfkujlgettlxdgrnqluw.supabase.co/storage/v1/object/public/venues/akasha.jpg",
      "cover_image": "https://xfkujlgettlxdgrnqluw.supabase.co/storage/v1/object/public/venues/akasha-cover.jpg",
      "address": "45 Boulevard Raspail",
      "postal_code": "75006",
      "city": "Paris",
      "country": "FR",
      "currency": "EUR",
      "venue_type": "hotel",
      "description": "Un sanctuaire de bien-être au cœur du 6ᵉ arrondissement.",
      "description_en": "A wellness sanctuary in the heart of the 6th arrondissement.",
      "timezone": "Europe/Paris"
    }
  ]
}