Category
List categories
Get a paginated list of providers categories filter by type and other queries
get/category
Query parameters
limitinteger
Limits the number of results returned per page
offsetinteger
Specifies the offset for paginating through results
includestring[]
Related resources to include in the response.
typestring
Unique category type slug to filter by. i.e. "menu"
slugstring
Unique category slug to filter by
nrnstring
Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources
dimensionsstring
Dimensions for the query, formatted as key:value pairs separated by commas (e.g., "key1:value1,key2:value2")
Response
Paginated list of categories
Example response
{
"results": [
{
"id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890",
"name": "Compute & Containers",
"slug": "compute-containers",
"description": "Category for compute and container services",
"category_type_id": "123e4567-e89b-12d3-a456-426614174000",
"sub_categories": [
{
"id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890",
"name": "Cloud Providers",
"slug": "cloud-providers",
"description": "Category for cloud platform providers",
"category_type_id": "123e4567-e89b-12d3-a456-426614174000",
"sub_categories": [],
"created_at": "2024-10-15T08:30:00Z",
"updated_at": "2024-10-20T14:45:00Z"
},
{
"id": "a3f1c2d4-e5b6-7890-ab12-cdef34567890",
"name": "Container Orchestration",
"slug": "container-orchestration",
"description": "Category for cloud platform providers",
"category_type_id": "123e4567-e89b-12d3-a456-426614174000",
"sub_categories": [],
"created_at": "2024-10-15T08:30:00Z",
"updated_at": "2024-10-20T14:45:00Z"
}
],
"created_at": "2024-10-15T08:30:00Z",
"updated_at": "2024-10-20T14:45:00Z"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.