Get list of categories

Listing categories is done by sending a GET request to the /categories endpoint.

CURL


curl -X GET https://app.ignitevideo.cloud/api/categories \
-H "Authorization: Bearer YOUR_TOKEN"

JavaScript / Node.js


const response = await fetch('https://app.ignitevideo.cloud/api/categories', {
headers: {
  Authorization: `Bearer YOUR_TOKEN`
}
});

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://app.ignitevideo.cloud/api/categories', [
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN'
]
]);

Query Parameters

For detailed information on all available operators and advanced filtering, see Querying. You can add the following URL query parameters to the request:

Parameter	Type	Description
`page`	`number`	The page number to fetch (default: 1).
`limit`	`number`	The number of categories to fetch per page (default: 10).
`sort`	`string`	The field to sort by. The default sort is `title`.
`where`	`object`	Custom query to filter the categories.
`depth`	`number`	Omit `depth` to receive related category objects such as `parent`. Set `depth=0` to receive ids.

A scoped API key only lists categories inside its category scope.

Example


/api/categories?page=1&limit=10

API Response

The response is a JSON object with the following properties:


{
  "docs": [...], // Array of category objects
  "totalDocs": number,
  "limit": number,
  "totalPages": number,
  "page": number,
  "pagingCounter": number,
  "hasPrevPage": boolean,
  "hasNextPage": boolean,
  "prevPage": number | null,
  "nextPage": number | null
}