List Venues

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" \

const response = await fetch('https://integrations.clopos.com/open-api/v2/venues', {
  headers: {
    'x-token': 'oauth_example_token',
  }
});

const venues = await response.json();

import requests

url = "https://integrations.clopos.com/open-api/v2/venues"
headers = {
    "x-token": "oauth_example_token",
}

response = requests.get(url, headers=headers)
venues = response.json()

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

Field	Type	Description
`id`	integer	Branch ID.
`name`	string	Branch name.
`is_main`	integer	`1` if this is the primary branch, `0` otherwise.
`media`	array	Image 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.

Overview

Auth

Venues

Users

Customers

Categories

Station

Products

Price Lists

Sales

Orders

Receipts

Tables

Purpose

HTTP Request

Request Example

Response

200 OK — List of branches

401 Unauthorized — Missing header

Field Reference

Branch object

Notes

​Purpose

​HTTP Request

​Request Example

​Response

​200 OK — List of branches

​401 Unauthorized — Missing header

​Field Reference

​Branch object

​Notes

Purpose

HTTP Request

Request Example

Response

200 OK — List of branches

401 Unauthorized — Missing header

Field Reference

Branch object

Notes