Skip to content
Dixa API/
/
Get category

Get category

Request

Get a knowledge category by id

Security
ApiKeyAuth(Required scopes: knowledge.content:r)
Path
categoryIdstring, (uuid)required
Query
languagestring

Language in which the article translations will be returned. If not provided, the default language will be used.

GET
/beta/knowledge/categories/{categoryId}
curl -i -X GET \
  'https://dev.dixa.io/beta/knowledge/categories/{categoryId}?language=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The category

Bodyapplication/json
dataobject(Category)required
Response
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": { … },
    "isDefaultLocation": true,
    "isLocked": false,
    "restrictions": { … },
    "parentCategory": "222e4567-e89b-12d3-a456-426614174111",
    "parentCollections": [ … ]
  }
}