Zum Hauptinhalt springen
GET
/
categories
List categories
curl --request GET \
  --url https://dashboard.scango.ch/api/v1/categories \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cat_01",
      "name": "Beverages",
      "description": ""
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 100
  }
}
Optional limit (1–5000, Standard 100) begrenzt die Anzahl der Kategorien. Die Antwort-meta enthält total, returned und limit. Siehe Einführung.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

​
limit
integer
Standard:100

Maximum number of categories to return. Integer 1–5000. Default 100.

Erforderlicher Bereich: 1 <= x <= 5000

Antwort

200 - application/json

List of categories with meta.

​
data
object[]
erforderlich
​
meta
object
erforderlich

Included on every list response. returned is the length of data. For Firestore-backed lists (/products without q, /orders, /suppliers, /categories), total equals returned for that response (the API does not return a separate full match count). For product search with q, total is the search index’s estimated number of matching documents. limit is the applied page size (query default 100, maximum 5000; search with q caps the effective page size at 250). offset is only used for product search with q.