Lister les catégories

Liste les catégories.

GET/categories

Autorisation

AutorisationJeton Bearer (API key) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

limitinteger

Taille de page (1–5000, défaut 100).

min 1 · max 5000 · default: 100

Réponses

200Catégories avec meta

dataCategory[]obligatoire

Afficher les propriétés

Array of Category

idstring

namestring

indexinteger

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

deletedboolean

hideStorestring[]

allowStorestring[]

createdatestring<date-time>

metaListMetaobligatoire

Métadonnées de liste. `returned` est la longueur de `data`. Les entrées de catalogue supprimées (soft delete) sont exclues des listes — `returned` peut être inférieur à `limit` même s'il reste des entrées actives.

Afficher les propriétés

totalintegerobligatoire

Avec recherche produit (`q`) : nombre estimé de correspondances. Sinon égal à `returned`. Peut être inférieur à `limit` lorsque des entrées supprimées ont été filtrées de la page.

returnedintegerobligatoire

Nombre d'éléments actifs dans `data` (entrées supprimées exclues).

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec `q`.

nextCursorstring

Curseur opaque pour la page suivante. Présent lorsque d'autres résultats sont possibles. Ne pas analyser ; transmettre tel quel comme `cursor`. Avec filtre soft-delete ou `store`, `returned < limit` ne signifie pas la fin de la liste.

400Requête incorrecte

errorValidationErrorobligatoire

Détails de validation.

Afficher les propriétés

formErrorsstring[]obligatoire

fieldErrorsobjectobligatoire

403Non autorisé

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

pathstringobligatoire

Chemin de la requête

Requête

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: {
    "Autorisation": "Bearer YOUR_TOKEN"
  }
});

Réponse

{
  "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"
  }
}