Liste der Kategorien abrufen

Kategorieliste abrufen

Das Auflisten von Kategorien erfolgt durch Senden einer GET-Anfrage an den 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'
]
]);

Query-Parameter

Für detaillierte Informationen zu allen verfügbaren Operatoren und erweiterter Filterung, siehe Abfragen. Du kannst die folgenden URL-Query-Parameter zur Anfrage hinzufügen:

Parameter	Typ	Beschreibung
`page`	`number`	Die abzurufende Seitennummer (Standard: 1).
`limit`	`number`	Die Anzahl der Kategorien pro Seite (Standard: 10).
`sort`	`string`	Das Feld, nach dem sortiert wird. Die Standardsortierung ist `title`.
`where`	`object`	Benutzerdefinierte Abfrage zum Filtern der Kategorien.
`depth`	`number`	Lass `depth` weg, um verwandte Kategorieobjekte wie `parent` zu erhalten. Setze `depth=0`, um Ids zu erhalten.

Ein API-Key mit Scope listet nur Kategorien innerhalb seines Kategorie-Scopes.

Beispiel


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

API-Antwort

Die Antwort ist ein JSON-Objekt mit den folgenden Eigenschaften:


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