Skip to main content

Read a category

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

Path Parameters
id uuid REQUIRED

Unique identifier for the entity represented as a UUID

Query Parameters
include string[]

Possible values: [sub_categories, parent, category_type]

Related resources to include in the response.

Responses
2XX

Object representing a category resource

Schema OPTIONAL
id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the category

slug string

Unique slug for the category

icon string OPTIONAL

Icon for the category

description string OPTIONAL

Description of the category

parent_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

category_type_id uuid

Unique identifier for the entity represented as a UUID

category_type object OPTIONAL

Category type of the category

id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the category type

slug string

Unique slug for the category type

description string OPTIONAL

Description of the category type

parent object OPTIONAL

Object representing a category resource

id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the category

slug string

Unique slug for the category

icon string OPTIONAL

Icon for the category

description string OPTIONAL

Description of the category

parent_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

category_type_id uuid

Unique identifier for the entity represented as a UUID

category_type object OPTIONAL

Category type of the category

id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the category type

slug string

Unique slug for the category type

description string OPTIONAL

Description of the category type

parent (circular) OPTIONAL

Parent category of the category

sub_categories (circular)[] OPTIONAL

Sub categories of the category

created_at date-time

Creation timestamp

updated_at date-time

Last update timestamp

sub_categories object[] OPTIONAL

Sub categories of the category

id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the category

slug string

Unique slug for the category

icon string OPTIONAL

Icon for the category

description string OPTIONAL

Description of the category

parent_id uuid OPTIONAL

Unique identifier for the entity represented as a UUID

category_type_id uuid

Unique identifier for the entity represented as a UUID

category_type object OPTIONAL

Category type of the category

id uuid

Unique identifier for the entity represented as a UUID

name string

Name of the category type

slug string

Unique slug for the category type

description string OPTIONAL

Description of the category type

parent (circular) OPTIONAL

Parent category of the category

sub_categories (circular)[] OPTIONAL

Sub categories of the category

created_at date-time

Creation timestamp

updated_at date-time

Last update timestamp

created_at date-time

Creation timestamp

updated_at date-time

Last update timestamp

4XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context

5XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context