---
id: provider-category-list
title: "List categories"
description: "Get a paginated list of providers categories filter by **type** and other queries"
sidebar_label: "List categories"
hide_title: true
hide_table_of_contents: true
api: eJztWW1v2zYQ/isEMQxJJjm246StgGEo0rcMRRqkCVYs8QKaOttsJFIlqSJe4P8+HCnZkvyWeBk6FP2UmDoe747PPUce76nKQDMrlDyJaUQzrb6KGPQNZxZGSk+iRBhLA2rZyNDoih4X47Qf0BgM1yLDyTSib8ESRjI2EpJZiAlOJGpISpWGFDoFGDIUiQVNBhOyt2cnGeztESZjouwYNPmSAwrRgGZMsxQsaFz7nho+hpTR6J7iHBpRIS2MQNOApkKKNE9p1JkGVKA9qGVCAypZiqKJSAU6ouFLLjTENBqyxEDTi/coZogdA5F5OgCNLmgweWIN0WBzLSEmGWj0FOg0eJhV7RVWqeHQwAPM+pgBF0OMHFrmZ5Gh0mW8hRwRO9YqH41La5fbxrRmuL6wkJrKuLFayBENKEi094qafHAz3zC/FyDR1BIaN25qf7rCNSF5ksew2bdzSBxgNBiVa44+KlLMJkI6jzWYTEkDreVeFdavsMQJbTTjUoovOZQgnRCcRUySj9CcGV5bRLSgRa5pCjK/ptuYgzofb86CJc2lhU1Q++n5KaZrY1czZi1o1PuX0iMmxd8u53+9aocv9vq/7ESMc5VLWw7s/rYTobkmYxyqgyzLEsFrk3HYcJVV5H6iTXdO8yTJEmaHSqfkvNhpcspSIDun56e7REOmwYB0UGZkLEAzzceCs4SIGMeHArTDvKzqmqFmVbillovRXh67VyIFaYSSZkkI6/7MRZ1JiFG3boA/U4x2TJghtzCJvrIkB5IxoQ0xgJSGHwcTwlWaMkN2oDVqBeSa3sKk46U7wS1Muv7/7jXdXeVbXDW46WI/oHdhNVboqltTxjeFgv2SnfdLoOFSZbY5guh++oR/6u6fLdB8jSu4khbJIrqnFcDsfzY4eVnky7Lyvqg2PvZq8Bk4/s40likrvEWO80aVfFsh5yl/fbXYiv8xRgVzr2f9x9K4Z0HP3tPqjl7N6lexbt9vkxPdzO6zALE4FmgLS84qoSoIqB49EVc36CRekhIe6jSieS7ihRQpGKyRvOg4DtjJPOV9rjByeXnyCmPrwblYmxqUguShhk5jFb2OXzfOLqxztFraVdUiuMfqei0nXMml02tim7S8mv9a5pCvvDffcENqJf9/Y8gyArnwtb6J+/r6x7Ua34z4d5EIzrWnyYaZqqfCdKGwQXAucM7hwuj+DPo0olxonidM75R7dw4s3kXR+jl1JReu1tCg6HxQvagsSUeuAZn6htllUZhBIWYWQiucPw34oQKMC341lqUZqs2z+N+pfc+MJV5LVfM0WEgS9Hxh+geXK81z2GzPynMW3bBrS8iiFrKao/2Awh1LswTKRKPsYNjh3bgXwuHgKHz2/EU7ZINON+QxDA96h0c4Mj8AHas0yy2Qn8mxkpYJiVfFEvR42MGvIa9+W0EFiPpC3l1FZ3OIAf1VcH+uWeBB2ukeAJoVwvMXg7DTjQ9C1js8Cnvdo6NOr/Os1263l8D0ajt3E5XH5Ky8UVc8xQ9hVvmwzk2nZXaCrs56Qgf79Uyh3Xa3F3baYefwov08OmhH7fafdTTMZbrti04v6h06GTyrbwWNcgM/aD4GY32bo4qOQiBUDYHvKHZPp2naJOziGD4/hy60hNbeErzC3rLbxRtHdi7eNToCrZU2JM6RFMnLsxOCh27NuC2uQI++d7xGjRsvHMYym5tjFVeLsb8eLKDl3cXFGfETCFeugxE7O1yHBrwProzU1a0vzG6W1+ejMgQNkhdUVQTV3+lRt19ko/KPY6VtQMZ5ymSogcVskJRr+aORrlW+FIzBrtcDir9lIoG40FXMK7LFFZbZPcQRLdxZV6ieCAZVlFb2rozL3JG+B+HhDxD+AOG3BSHG686WzRw8HtzChEbNDk5AXU/ogZ0cZP8U7FhhLRq5PnPG7BilK7cdPN+UHfZcJzSiY2szE+3vs0y0qsu3uEpdSTHAcy3s5CNi2cNzAEyDfpmj+tnOoCJcwYnRqBCiQfHPm/JQ+/sfF9T3kYeqmhnVkw7a6Lek3Wq3Ou5irIxNmcuqIgrYP6q3ohqXllly/ifvFYXbCKX9LGHC5YGL6X0R+avZMQHL5VgZi2P39wNm4FIn0ykO+y4f7kcsDKbDiiZx1Z1HPlyssNWDruw1FVjzXe6Hm7LNY8Vae2avJFsa9LgXhrWmzF81trRlu2eGtTYV7xtPZNDiQ8PaxYtL3/rFvajvxD9EstbXnk/o4w8tcAYekqcBHQOLQVf48iXnkFWhslCCa6T49jUSzz/oufwk
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={"List categories"}
>
</Heading>

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



Get a paginated list of providers categories filter by **type** and other queries

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

<ParamsDetails
  parameters={[{"schema":{"type":"integer","minimum":1},"in":"query","name":"limit","required":false,"description":"Limits the number of results returned per page"},{"schema":{"type":"integer","minimum":0},"in":"query","name":"offset","required":false,"description":"Specifies the offset for paginating through results"},{"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":{"type":"string"},"in":"query","name":"type","required":false,"description":"Unique category type slug to filter by. i.e. \"menu\""},{"schema":{"type":"string"},"in":"query","name":"slug","required":false,"description":"Unique category slug to filter by"},{"schema":{"title":"NRN","type":"string","pattern":"^organization=[0-9*]+(:account=[0-9*]+)?(:namespace=[0-9*]+)?(:application=[0-9*]+)?(:scope=[0-9*]+)?$","description":"Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources"},"in":"query","name":"nrn","required":false},{"schema":{"title":"Dimensions","type":"string","description":"Dimensions for the query, formatted as key:value pairs separated by commas (e.g., \"key1:value1,key2:value2\")"},"in":"query","name":"dimensions","required":false}]}
>
  
</ParamsDetails>

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

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"2XX":{"description":"Paginated list of categories","content":{"application/json":{"schema":{"title":"CategoryList","type":"object","properties":{"paging":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"description":"Limits the number of results returned"},"offset":{"type":"integer","minimum":0,"description":"Specifies the offset for paginated results"}},"required":["limit","offset"]},"results":{"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"}}}},"required":["paging","results"],"description":"Paginated list of categories"}}}},"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>