Sign in
Category

Read a category

Read a provider category by ID. Use the include query parameter to retrieve related resources.

get/category/{id}

Path parameters

idstring uuid required

Unique identifier for the entity represented as a UUID

Query parameters

includestring[]

Related resources to include in the response.

Response

Object representing a category resource

idstring uuid required

Unique identifier for the entity represented as a UUID

namestring required

Name of the category

slugstring required

Unique slug for the category

iconstring

Icon for the category

descriptionstring

Description of the category

parent_idstring uuid

Unique identifier for the entity represented as a UUID

category_type_idstring uuid required

Unique identifier for the entity represented as a UUID

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

Example response

{
  "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.