Skip to main content
GET
/
venues
List Venues
curl --request GET \
  --url https://integrations.clopos.com/open-api/venues \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "is_main": 123
    }
  ]
}

Authorizations

x-token
string
header
required

Access token obtained from /auth endpoint

x-brand
string
header
required

Brand identifier

x-venue
string
header
required

Venue identifier

Response

200 - application/json

Venues retrieved successfully.

success
boolean
data
object[]