Obtenir la liste des catégories

Récupération de la liste

Pour lister les catégories, envoie une requête GET à l’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'
]
]);

Paramètres de requête

Pour des informations détaillées sur tous les opérateurs disponibles et le filtrage avancé, consulte Interrogation. Tu peux ajouter les paramètres de requête URL suivants :

Paramètre	Type	Description
`page`	`number`	Le numéro de page à récupérer (par défaut : 1).
`limit`	`number`	Le nombre de catégories par page (par défaut : 10).
`sort`	`string`	Le champ de tri. Le tri par défaut est `title`.
`where`	`object`	Requête personnalisée pour filtrer les catégories.
`depth`	`number`	Omets `depth` pour recevoir les objets catégorie liés, comme `parent`. Définis `depth=0` pour recevoir des ids.

Une Clé API avec périmètre ne liste que les catégories de son périmètre de catégories.

Exemple


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

Réponse API

La réponse est un objet JSON avec les propriétés suivantes :


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