Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.clopos.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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/v2/venues
This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

​
Request Example

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

​
Response

​
200 OK — List of branches

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Main",
      "is_main": 1,
      "media": []
    },
    {
      "id": 2,
      "name": "Baku",
      "is_main": 0,
      "media": []
    },
    {
      "id": 3,
      "name": "Masally",
      "is_main": 0,
      "media": []
    }
  ]
}

​
401 Unauthorized — Missing header

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

​
Field Reference

​
Branch object

FieldTypeDescription
idintegerBranch ID.
namestringBranch name.
is_maininteger1 if this is the primary branch, 0 otherwise.
mediaarrayImage attachments. See Media object.

​
Notes

  • This endpoint returns all branches you have access to; use client-side logic to filter the result set.
  • Use is_main to identify the primary branch in multi-location setups.
  • Although the response size is small, client-side caching is recommended for large brands.