Référence APILister les sections d'une collection
GET/v1/collections/{id}/sections

Lister les sections d'une collection

Récupère toutes les sections d'une collection, triées par position croissante.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"data": [
{
"id": "sec_8Hk2pQ9mLrT4",
"name": "Documents juridiques",
"position": 0,
"created_at": "2026-05-21T09:14:32.118Z",
"is_visible": true,
"description": "Statuts, pactes et baux"
},
{
"id": "sec_2Vn7cW0aZbE1",
"name": "Comptabilité",
"position": 10,
"created_at": "2026-05-21T09:18:05.402Z",
"is_visible": true,
"description": null
}
],
"object": "list"
}
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.

ChampTypeRequisDescription
idstring (path)OuiIdentifiant 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.

ChampTypeDescription
objectstringToujours "list".
dataarrayTableau des sections triées par position croissante.
data[].idstringIdentifiant unique de la section.
data[].namestringNom de la section.
data[].descriptionstring | nullDescription optionnelle.
data[].positionnumberOrdre d'affichage (croissant).
data[].is_visiblebooleanVisibilité de la section.
data[].created_atstring (ISO 8601)Date de création.

Erreurs

CodeQuandRésolution
401 missing_api_keyEn-tête Authorization absent.Ajoutez Authorization: Bearer cof_live_....
401 invalid_api_keyClé invalide ou préfixe non reconnu.Vérifiez le format et la validité de la clé.
403 scope_missingLa clé n'a pas le scope collections:read.Émettez une clé incluant collections:read.
404 not_foundCollection inexistante ou hors de votre espace de travail.Vérifiez l'id de la collection.
429 rate_limitedQuota de requêtes par minute dépassé.Patientez selon l'en-tête Retry-After.
500 internal_errorErreur côté base de données.Réessayez ; persistez le request_id pour le support.

Voir aussi