Skip to main content
GET
/
stations
List stations
curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/stations \
  --header 'x-token: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": 123,
      "can_print": true,
      "reminder_enabled": true,
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-token
string
header
required

JWT access token obtained from /v2/auth endpoint

Query Parameters

​
status
enum<integer>

Filter by station status

Available options:
0,
1
​
can_print
boolean

Filter stations that can print order tickets

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
limit
integer
default:50

Number of stations to return per page

Required range: 1 <= x <= 200

Response

200 - application/json

Stations retrieved successfully

​
success
boolean
​
data
object[]
​
total
integer
​
time
integer
​
timestamp
string<date-time>