Skip to content

English

DeutschNot translated English Français ItalianoNot translated

Get category by ID

Get a category by id.

GET/categories/{categoryId}

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Path parameters

categoryIdstringrequired

Responses

200Category details

dataCategoryrequired

Show properties

idstring

namestring

indexinteger

showOnScreenboolean

imageUrlstring

marginMinPercentnumber

marginMaxPercentnumber

deletedboolean

hideStorestring[]

allowStorestring[]

createdatestring<date-time>

403Unauthorized

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

404Not found

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/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dashboard.scango.ch/api/v1/categories/string", {
  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"
  }
}