Skip to main content

GET /v1/categories

Scope​

read_items

Request parameters​

NameInTypeRequiredDescription
parent_idquerystringoptionalFilter by parent category.
statusqueryenum(activeinactiveall)

Response example​

{
"data": [
{
"id": "1",
"parent_id": "string",
"name": "string",
"status": "active",
"sort": 0
}
]
}

Description​

List categories (UCP Catalog: Lookup helper)

Error response example​

{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_items'",
"request_id": "req_01H..."
}
}

Possible errors: 401 / 403 / 429