Réponse exemple
GET/v1/collections/{id}/sectionsListe les sections d'une collection donnée.Renvoie l'ensemble des sections rattachées à la collection identifiée par {id}. Les sections structurent le contenu d'une collection en regroupant ses éléments. Le résultat est trié par `position` croissante, ce qui reflète l'ordre d'affichage. La collection est d'abord vérifiée comme appartenant à votre espace de travail : si elle n'existe pas ou n'est pas la vôtre, une erreur 404 not_found est renvoyée avant toute lecture des sections.
Authentification
Cette requête exige une clé API valide disposant du scope collections:read. Transmettez la clé via l'en-tête Authorization: Bearer cof_live_.... Une clé sans ce scope reçoit une erreur 403 scope_missing.
Paramètres de requête
Aucun paramètre de requête (query string) n'est pris en charge. Seul le segment de chemin {id} (identifiant de la collection) est requis.
| Champ | Type | Requis | Description |
|---|---|---|---|
| id | string (path) | Oui | Identifiant de la collection dont on liste les sections. |
Réponse
La réponse est un objet liste : object vaut "list" et data contient le tableau des sections (vide si aucune section). Chaque section expose id, name, description (peut être null), position, is_visible et created_at.
| Champ | Type | Description |
|---|---|---|
| object | string | Toujours "list". |
| data | array | Tableau des sections triées par position croissante. |
| data[].id | string | Identifiant unique de la section. |
| data[].name | string | Nom de la section. |
| data[].description | string | null | Description optionnelle. |
| data[].position | number | Ordre d'affichage (croissant). |
| data[].is_visible | boolean | Visibilité de la section. |
| data[].created_at | string (ISO 8601) | Date de création. |
Erreurs
| Code | Quand | Résolution |
|---|---|---|
| 401 missing_api_key | En-tête Authorization absent. | Ajoutez Authorization: Bearer cof_live_.... |
| 401 invalid_api_key | Clé invalide ou préfixe non reconnu. | Vérifiez le format et la validité de la clé. |
| 403 scope_missing | La clé n'a pas le scope collections:read. | Émettez une clé incluant collections:read. |
| 404 not_found | Collection inexistante ou hors de votre espace de travail. | Vérifiez l'id de la collection. |
| 429 rate_limited | Quota de requêtes par minute dépassé. | Patientez selon l'en-tête Retry-After. |
| 500 internal_error | Erreur côté base de données. | Réessayez ; persistez le request_id pour le support. |
Voir aussi
- POST /v1/collections/{id}/sections — créer une section
- PATCH /v1/collections/{id}/sections — modifier une section
- DELETE /v1/collections/{id}/sections — supprimer une section (orpheline ses éléments)