List Catalog Categories
GET /catalog-categories
Returns a paginated list of application categories. Use this endpoint to populate category filter dropdowns in the catalog UI.
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
q | string | - | Search filter against name (case-insensitive, partial match) |
sort_by | string | name | Sort field: name |
sort_order | string | asc | Sort direction: asc, desc |
page_size | integer | 50 | Items per page. Max: 500 |
cursor | string | - | Pagination cursor from a previous response |
Response
| Field | Type | Description |
|---|---|---|
data | CatalogCategory[] | Array of category objects |
total_count | integer | Total number of categories matching the current filters |
next_cursor | string | null | Cursor to pass as cursor for the next page. null when on the last page. |
Example Request
curl -X GET "https://api.example.com/v2/catalog-categories" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Search by name
curl -X GET "https://api.example.com/v2/catalog-categories?q=product" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Example Response
{
"data": [
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Browser"
},
{
"id": "a7b8c9d0-e1f2-3456-abcd-789012345678",
"name": "Communication"
},
{
"id": "b8c9d0e1-f2a3-4567-bcde-890123456789",
"name": "Design"
},
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Productivity"
}
],
"total_count": 12,
"next_cursor": null
}
Empty Result
{
"data": [],
"total_count": 0,
"next_cursor": null
}
Pagination
This endpoint uses cursor-based pagination.
- Omit
cursoron the first request - If
next_cursoris notnull, pass its value ascursoron the next request - Repeat until
next_cursorisnull
Error Responses
| Status | Description |
|---|---|
| 400 | Invalid query parameters |
| 401 | Authentication required |
| 403 | Insufficient permissions |
| 500 | Server error |
Related Endpoints
- List Catalog Apps - Browse catalog apps (includes embedded categories)