List categories

Returns product categories for the organization. Each category `id` is a UUID.

GEThttps://api.tracksales.co/v1/categories

Required scope: categories:read

Request URL: https://api.tracksales.co/v1/categories

Query Params

searchstring

Search by name, code, or reference

location_idinteger

Filter by branch/location ID

limitinteger

Page size (default 20, max 100)

offsetinteger

Pagination offset (default 0)

Responses

200OK

Request succeeded.

401Unauthorized

API key is missing or invalid.

403Forbidden

API key lacks the required scope.

404Not Found

Categories was not found.

422Validation Error

Request validation failed.

curl -X GET 'https://api.tracksales.co/v1/categories?limit=20&search=acme' \
  -H 'Authorization: Bearer ts_live_YOUR_API_KEY' \
  -H 'Accept: application/json'

{
    "success": true,
    "data": {
        "categories": [
            {
                "id": "770e8400-e29b-41d4-a716-446655440003",
                "name": "Electronics",
                "displayOnSalesGrid": true,
                "lastModified": "2026-07-14"
            }
        ],
        "total": 1,
        "limit": 20,
        "offset": 0
    }
}

{
    "success": false,
    "error": {
        "code": "unauthenticated",
        "message": "Invalid or revoked API key."
    }
}

{
    "success": false,
    "error": {
        "code": "forbidden",
        "message": "API key lacks required scope."
    }
}

{
    "success": false,
    "message": "Categories not found"
}

{
    "success": false,
    "message": "Validation failed",
    "errors": {
        "field": [
            "The field is required."
        ]
    }
}