Skip to main content
GET
/
stations
List stations
curl --request GET \
  --url https://integrations.clopos.com/open-api/stations \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <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"
}

​
Purpose

Allows you to check printer, reminder, and status information by retrieving all stations in your POS and kitchen flows in a single call.

​
HTTP Request

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

​
Authorization

Required headers:
  • x-token
  • x-brand
  • x-venue

​
Query Parameters

​
status
integer
Filter by station status (1 = active, 0 = inactive).
​
can_print
boolean
Filter stations that can redirect to a printer.
​
page
integer
default:"1"
Page number for pagination.
​
limit
integer
default:"50"
Number of stations to return (1-200).

​
Request Example

curl -X GET "https://integrations.clopos.com/open-api/stations?status=1&can_print=true" \
  -H "x-token: oauth_example_token" \
  -H "x-brand: openapitest" \
  -H "x-venue: 1"

​
Response

​
200 OK — List of stations

{
  "success": true,
  "data": [
    {
      "id": "kitchen",
      "name": "Kitchen",
      "status": 1,
      "can_print": true,
      "reminder_enabled": true,
      "description": "Primary hot line",
      "created_at": "2024-01-20T13:00:00Z",
      "updated_at": "2024-01-20T15:00:00Z"
    },
    {
      "id": "bar",
      "name": "Bar",
      "status": 1,
      "can_print": true,
      "reminder_enabled": false,
      "description": "Drink station",
      "created_at": "2024-01-18T09:10:00Z",
      "updated_at": "2024-01-19T17:45:00Z"
    }
  ],
  "total": 4,
  "time": 19,
  "timestamp": "2024-01-20T15:10:00Z"
}

​
401 Unauthorized — Authorization missing

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

​
Field Reference

​
Top-level fields

FieldTypeDescription
successbooleanSuccess status of the request.
dataarrayStation objects.
totalnumberTotal number of stations.
timenumberResponse time.
timestampstringISO 8601 date.

​
Station object

FieldTypeDescription
idstringStation identifier.
namestringStation name.
statusinteger1 = active, 0 = inactive.
can_printbooleanCan be redirected to a printer.
reminder_enabledbooleanIs reminder notification on?
descriptionstringOptional description.
created_atstringCreation time.
updated_atstringLast update time.

​
Notes

  • The can_print=true parameter returns only stations that can print receipts; you can use false for digital-only points like kitchen screens.
  • If the reminder feature (reminder_enabled) is off, “not sent to station” warnings will not appear on the terminal.
  • The active/inactive status of stations affects product routing on the POS side; inactive stations are not assigned to new orders.
  • Adjust pagination parameters (page, limit) for performance in large restaurant chains; it is generally not necessary for a single branch.

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

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>