Obter lista de categorias

Obter a lista de categorias

Listar categorias faz-se enviando um pedido GET para o endpoint /categories.

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'
]
]);

Parâmetros de consulta

Para detalhes sobre todos os operadores disponíveis e filtragem avançada, consulta Consultas. Podes acrescentar os seguintes parâmetros de consulta ao URL do pedido:

Parâmetro	Tipo	Descrição
`page`	`number`	O número da página a obter (predefinição: 1).
`limit`	`number`	O número de categorias a obter por página (predefinição: 10).
`sort`	`string`	O campo por que ordenar. A ordenação predefinida é `title`.
`where`	`object`	Consulta personalizada para filtrar as categorias.
`depth`	`number`	Omite `depth` para receberes objetos de categoria relacionados, como `parent`. Define `depth=0` para receberes ids.

Uma Chave API com âmbito só lista categorias dentro do seu âmbito de categoria.

Exemplo


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

Resposta da API

A resposta é um objeto JSON com as seguintes propriedades:


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