List categories

List categories.

GET/categories

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Query parameters

limitinteger

Page size (1–5000, default 100).

min 1 · max 5000 · default: 100

Responses

200Categories with meta

dataCategory[]required

Show properties

Array of Category

idstring

namestring

indexinteger

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

deletedboolean

hideStorestring[]

allowStorestring[]

createdatestring<date-time>

metaListMetarequired

List metadata. `returned` is the length of `data`. Soft-deleted catalog rows are omitted from list results, so `returned` may be less than `limit` even when more active items exist. When `nextCursor` is present, more pages may exist — keep paging until `nextCursor` is absent.

Show properties

totalintegerrequired

With product search (`q`) without `store`: estimated match count. With `store`: equals `returned` after store visibility filtering. Otherwise equals `returned`. Soft-deleted items are omitted, so a page may be shorter than `limit` even when more active items exist.

returnedintegerrequired

Number of active items in `data` (soft-deleted rows excluded).

limitintegerrequired

Applied page size.

offsetinteger

Only for product search with `q`.

nextCursorstring

Opaque cursor for the next page. Present when more results may exist. Do not parse; pass unchanged as `cursor`. Under soft-delete filtering, `returned < limit` does not mean the list is finished.

400Bad request

errorValidationErrorrequired

Validation details.

Show properties

formErrorsstring[]required

fieldErrorsobjectrequired

403Unauthorized

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

Request

curl -X GET "https://dashboard.scango.ch/api/v1/categories" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dashboard.scango.ch/api/v1/categories", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "index": 0,
      "showOnScreen": true,
      "imageUrl": "string",
      "marginMinPercent": 0,
      "marginMaxPercent": 0,
      "deleted": true,
      "hideStore": [
        "string"
      ],
      "allowStore": [
        "string"
      ],
      "createdate": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}