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
    }
  ]
}

​
Purpose

Allows you to quickly retrieve active branches connected to your brand to initiate location-based operations.

​
HTTP Request

GET https://integrations.clopos.com/open-api/venues

​
Authorization

Standard headers are required:
  • x-token
  • x-brand
  • x-venue

​
Request Example

curl -X GET "https://integrations.clopos.com/open-api/venues" \
  -H "x-token: oauth_example_token" \
  -H "x-brand: openapitest" \
  -H "x-venue: 1"

​
Response

​
200 OK — List of branches

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Downtown Coffee Shop",
      "address": "123 Main St, City, State 12345",
      "status": 1,
      "phone": "+1-555-0123",
      "email": "[email protected]"
    }
  ],
  "time": 18,
  "timestamp": "2024-01-20T16:25:00Z"
}

​
401 Unauthorized — Missing header

{
  "success": false,
  "error": "unauthorized",
  "message": "Missing authentication headers"
}

​
Field Reference

​
Top-level fields

FieldTypeDescription
successbooleanSuccess status of the request.
dataarrayBranch objects.
timenumberResponse time (ms).
timestampstringISO 8601 date.

​
Branch object

FieldTypeDescription
idnumberBranch ID.
namestringBranch name.
addressstringAddress.
statusnumber1 = active, 0 = inactive.
phonestringContact number.
emailstringContact email.

​
Notes

  • This endpoint returns all branches you have access to; use client-side logic to filter the result set.
  • The status field indicates inactive branches; to work only with active branches, retrieve those where status === 1.
  • Although the response size is small, client-side caching is recommended for large brands.
  • You can use the branch ID as x-venue in other endpoints.

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[]