List categories

List categories. Not paginated: returns up to limit active categories, ordered by name, without nextCursor.

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

200

Categories with meta

dataCategory[]required

Show properties

Array of Category

idstringrequired

namestring

externalIdstring

Optional external identifier

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 items in data. With includeDeleted=true (orders), deleted orders count too.

limitintegerrequired

Applied page size.

offsetinteger

Only for product search with q.

nextCursorstring

Opaque cursor for the next page; pass it unchanged as cursor. Present when more results may exist. Soft-deleted rows are filtered out after reading, so a page can be shorter than limit while nextCursor is set. Never returned for categories, suppliers and stores, which are not paginated.

400

Invalid query parameters.

errorValidationErrorrequired

Validation details.

Show properties

formErrorsstring[]required

fieldErrorsobjectrequired

403

Missing, unknown or inactive API key, or a Read key on a write operation.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Parameters

limitqueryPage size (1–5000, default 100).

Request

curl -X GET 'https://dashboard.scango.ch/api/v1/categories' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

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

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/categories",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/categories',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Response

{
  "data": [
    {
      "id": "cat_01",
      "name": "Beverages",
      "index": 1,
      "showOnScreen": true
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 100
  }
}

{
  "error": {
    "formErrors": [],
    "fieldErrors": {
      "limit": [
        "Number must be less than or equal to 5000"
      ]
    }
  }
}

{
  "statusCode": 403,
  "message": "Unknown Error",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/products"
}