Get Subcategories by Parent Id

All API requests should contain authorization headers.

Request

GET /categories/{parentId}/subcategories?includeHidden={includeHidden}

Query Parameters

NameTypeRequiredComments

parentId

integer

no

Id of category which subcategories you want to receive. Without this parameter response will contain root categories

includeHidden

boolean

no

if set to true response will contain hidden categories. Default value is false

Response

{
    "data": [
        {
            "autoArchive": false,
            "canBeChosen": true,
            "isHidden": false,
            "isMuted": false,
            "parentId": 35611,
            "id": 35795,
            "name": "ACME Corp"
        },
        {
            "autoArchive": false,
            "canBeChosen": true,
            "isHidden": false,
            "isMuted": false,
            "parentId": 35611,
            "id": 35797,
            "name": "Dunder Mifflin Paper Co"
        },
        {
            "autoArchive": false,
            "canBeChosen": true,
            "isHidden": false,
            "isMuted": false,
            "parentId": 35611,
            "id": 35796,
            "name": "Pawtucket Brewery"
        }
    ],
    "errorCode": -1,
    "errorText": null
}

Data field has type array of Category objects.

Last updated