Skip to main content
GET
/
categories
List categories
curl --request GET \
  --url https://integrations.clopos.com/open-api/v2/categories \
  --header 'x-token: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "parent_id": 123,
      "name": "<string>",
      "slug": "<string>",
      "type": "PRODUCT",
      "color": "<string>",
      "status": 123,
      "depth": 123,
      "_lft": 123,
      "_rgt": 123,
      "properties": {},
      "children": "<array>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z",
  "unix": 123
}

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.

Authorizations

​
x-token
string
header
required

JWT access token obtained from /v2/auth endpoint

Query Parameters

​
page
integer
default:1

Page number for pagination (starts at 1)

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

Number of categories to return per page (1-999)

Required range: 1 <= x <= 999
​
parent_id
string | null

Filter to categories under a specific parent ID

​
type
enum<string>

Filter by category type

Available options:
PRODUCT,
INGREDIENT,
ACCOUNTING
​
include_children
boolean
default:true

Include nested child categories in the response

​
include_inactive
boolean
default:false

Whether to include inactive categories

Response

Categories retrieved successfully

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