Aller au contenu
scango.ch
Français
Esc
naviguerouvrir⌘Japerçu

Obtenir une catégorie par ID

Récupère une catégorie par id.

GET/categories/{categoryId}
Autorisation
AutorisationJeton Bearer (API key) · headerobligatoire
Clé API de l’organisation.
Paramètres de chemin
categoryIdstringobligatoire
Réponses
200Détails de la catégorie
dataCategoryobligatoire
Afficher les propriétés
idstring
namestring
indexinteger
showOnScreenboolean
imageUrlstring
marginMinPercentnumber
marginMaxPercentnumber
deletedboolean
hideStorestring[]
allowStorestring[]
createdatestring<date-time>
403Non autorisé
statusCodeintegerobligatoire
Code de statut HTTP
messagestringobligatoire
Message d’erreur lisible
timestampstring<date-time>obligatoire
pathstringobligatoire
Chemin de la requête
404Not found
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/string" \
  -H "Authorization: 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"
  }
}