---
id: provider-category-read
title: "Read a category"
description: "Read a provider category by ID. Use the **include** query parameter to retrieve related resources."
sidebar_label: "Read a category"
hide_title: true
hide_table_of_contents: true
api: eJztWl9v2zYQ/yrEPQxtINmy46Sp3oqk3TIMa9AmWLHACGjxbLOTSJWkgniGv/twlGRLsZOmWbBmhZ6SUHfH+/O74x3DJegcDXdSq1MBMeRGX0uB5irhDmfaLGKDXEAAjs8sxJdwXK3DOACBNjEyJ2aI4QNywTirJbBaApss2OlJj11YZG6ObG9PqiQtBO7tsS8FmgXLueEZOjTMaWbQGYnXyAym3KFgBq0uTIK2BwGsSUmZJdhkjhmHeAlukSPEwI3hCwhAOsxsY906I9UMAkBVZGSHLSa1jRJtKRmVgwBqva8863i1CkCSfV5XCEDxjCRWRkAABr8U0qCAeMpTi9t+uWUHWVlxM6m8TwzaXCuLPVgFLaukS2mzUx+CW6ZMtcm4gxiKQtL39rYXSn4pkEmBysmpRMOm2vjNaMEtmMHcoEVFunHLOLu4OD2B2tqcu3nDWNGy05kCV+MAbkJVpGmecke6kMKJzjKuxFXF16/R0K+9ShvU1voADT99oh9t5d9PPmPiNipKNWN8g6jalRQtrRzFLV4Cz/NUJh7L/c+W5OwAiPaSIQAuhCRSnp4ZygFHMKgjmDeWlmT994pF6cdtGLfl/84zZHrqJTYdbdNi9nXuSjsiXuvVlCKT0pf3SzlNtNrJ3iL7mpSTzV+7DCqT9Oo7BqRVHZ6NIk0t6gp9TuvBFu7b+9fEjMi2PP5DJII37WmyYS3qqTBdCVw1i+tlWW29wZXS4zX0u0rWVbKuknWV7EeoZJBIkxQpNy/q2NEI8ZJI2835ne393RLaen8sJmwjb1c6JgapSb/ibpcX1lAQ3GHopLfnFvxIAPmFvlrHs5zEFrn4d2J/49axUkpT8irYSpIP5Zz22D763qjtKBYtl7UMHQeANzzLU6wTDfj+dJAMxSjEg8lh+OrodRTyyWAYJgKn+6ODQ1rZDBvHOssLh+wndqyV41LRtFeDniYM+homzW93lAJCfUXPuBJszcMsmmuZ+MFvuw7CYLiPpFaIR68n4WAo9kM+OjgMR8PDw8Fo8GoURdEOmF4+ztxUF4KdVYNS01L6EOaND/eZ6aXUoxhrcj2hgeN2psAwGo7CQRQODs6jo3g/iqPozzYaNjTD6HwwikcHnobG3EdBow7ge5PM0bry6qKJjoog1LcIfiDfPZ2k1cNrbdd3dn1n13d2fWfXd3Z9Z9d3dn3n/7R36vrOZ9J3dpWyq5RdpXzG2d5VymdRKVdUSka7/kn+zhcn759W+UBjtLFMFFTE2JuzUyaVQ8MT4rPf9D/zqoK9JYk7JqH2bGMdd4U91qI5Zqgim6DZiu4v5+dnrGRgifYPIYTXQ83KYcbvSGW/Le7+kcNzlfJKr0zRoEqq0lKF+u8Sb6sAyk2+KvzjXBsXsHmRcRXScxg+Seu9yqHPtE6qDK3lswdofYKOyxRFJaviq9DtD4L1DYsvjHjjdhydj4ZB80BpxK72y8aQcQnCgw6EHQi/LwjJXzcOlfXcdJz/hQuIbz9ECuCapwU+8EESVesM3VzT2TFDjyl6/RTDmqi/lGJFRwaa6/rtWWFSiGHuXG7jfp/nstfUoZfozJ8DFpPCSLf4SIAuMTpBbtC8KWiPdXhIEO3gySCuiCCofnlXd6K//nEO5Zu0qW6mR7M9IR3LuES9qDfw937auoz71KpcUb3Xa1xV3bqTWWfof/O0r/IDAayfp1z67PBOXlbxuISGsrEU1MjOtXX0ZbmccIsXJl2taLl8rEdhEtJSqtzxOq9t5bc81LtD4RKPm8eBFRDBY+GaG0nKfKNiLz5USfKS3bVtfU+lFs091+oIWNEN2By5QNPImzdJgrlrsGyV4lZy/PyWsPcP9ZxJXA==
sidebar_class_name: "get api-method"
info_path: docs/api/providers
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read a category"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/category/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



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

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"type":"array","items":{"type":"string","enum":["sub_categories","parent","category_type"]}},"in":"query","name":"include","required":false,"description":"Related resources to include in the response."},{"schema":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"in":"path","name":"id","required":true}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Object representing a category resource","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the category"},"slug":{"type":"string","description":"Unique slug for the category"},"icon":{"type":"string","description":"Icon for the category"},"description":{"type":"string","description":"Description of the category"},"parent_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"category_type_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"category_type":{"title":"CategoryType","type":"object","description":"Category type of the category","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the category type"},"slug":{"type":"string","description":"Unique slug for the category type"},"description":{"type":"string","description":"Description of the category type"}},"required":["id","name","slug"]},"parent":{"type":"object","additionalProperties":false,"properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the category"},"slug":{"type":"string","description":"Unique slug for the category"},"icon":{"type":"string","description":"Icon for the category"},"description":{"type":"string","description":"Description of the category"},"parent_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"category_type_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"category_type":{"title":"CategoryType","type":"object","description":"Category type of the category","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the category type"},"slug":{"type":"string","description":"Unique slug for the category type"},"description":{"type":"string","description":"Description of the category type"}},"required":["id","name","slug"]},"parent":"circular(CategoryRead)","sub_categories":{"type":"array","items":"circular(CategoryRead)","description":"Sub categories of the category"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"title":"CategoryRead","description":"Object representing a category resource","required":["id","name","slug","category_type_id","created_at","updated_at"],"example":{"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"}},"sub_categories":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the category"},"slug":{"type":"string","description":"Unique slug for the category"},"icon":{"type":"string","description":"Icon for the category"},"description":{"type":"string","description":"Description of the category"},"parent_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"category_type_id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"category_type":{"title":"CategoryType","type":"object","description":"Category type of the category","properties":{"id":{"title":"Id","type":"string","format":"uuid","description":"Unique identifier for the entity represented as a UUID"},"name":{"type":"string","description":"Name of the category type"},"slug":{"type":"string","description":"Unique slug for the category type"},"description":{"type":"string","description":"Description of the category type"}},"required":["id","name","slug"]},"parent":"circular(CategoryRead)","sub_categories":{"type":"array","items":"circular(CategoryRead)","description":"Sub categories of the category"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"title":"CategoryRead","description":"Object representing a category resource","required":["id","name","slug","category_type_id","created_at","updated_at"],"example":{"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"}},"description":"Sub categories of the category"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"title":"CategoryRead","description":"Object representing a category resource","required":["id","name","slug","category_type_id","created_at","updated_at"],"example":{"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"}}}}},"4XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}},"5XX":{"description":"Format for representing errors during API interactions","content":{"application/json":{"schema":{"title":"Error","type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code indicating the error"},"code":{"type":"string","description":"Unique error code for reference and categorization"},"error":{"type":"string","description":"Short, human-readable error type or category"},"message":{"type":"string","description":"Detailed error message providing additional context"}},"description":"Format for representing errors during API interactions","required":["statusCode","error","message"]}}}}}}
>
  
</StatusCodes>


      