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 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/v2/stations
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.

​
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/v2/stations?status=1" \
  -H "x-token: oauth_example_token" \

​
Response

​
200 OK — List of stations

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Kitchen",
      "status": 1,
      "type": 1,
      "printable": 1,
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T14:08:49.000000Z"
    },
    {
      "id": 2,
      "name": "Bar",
      "status": 1,
      "type": 0,
      "printable": 1,
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T14:08:49.000000Z"
    },
    {
      "id": 3,
      "name": "Tandir",
      "status": 1,
      "type": 0,
      "printable": 0,
      "created_at": "2026-01-13T14:36:51.000000Z",
      "updated_at": "2026-01-13T14:36:51.000000Z"
    }
  ],
  "total": 3
}

​
401 Unauthorized — Authorization missing

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

​
Field Reference

​
Station object

FieldTypeDescription
idintegerStation identifier.
namestringStation name.
statusinteger1 = active, 0 = inactive.
typeintegerStation type. 1 = kitchen, 0 = other.
printableinteger1 if the station can print tickets, 0 otherwise.
created_atstringCreation timestamp (ISO 8601).
updated_atstringLast update timestamp (ISO 8601).

​
Notes

  • Stations with printable=0 are designed only for screen notifications or digital preparation processes.
  • 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.