GET/v1/intakes

Lister les intakes

Récupère la liste paginée des intakes du compte avec pagination par curseur et filtre optionnel sur l'état actif.

Réponse exemple

{
  "data": [
    {
      "id": "int_4f2a9c1b",
      "name": "Dépôt KYC clients 2026",
      "enabled": true,
      "created_at": "2026-06-11T14:23:00Z",
      "reference_required": true
    }
  ],
  "limit": 20,
  "object": "list",
  "has_more": false,
  "next_cursor": null
}

L'endpoint <code>GET /v1/intakes</code> renvoie la liste paginée des points de réception configurés sur votre compte. Vous l'utilisez pour afficher un tableau d'administration, retrouver l'identifiant d'un intake à partir de son nom, ou synchroniser votre back-office avec l'état de vos formulaires de dépôt. La pagination repose sur un <b>curseur opaque</b>, ce qui permet de parcourir des comptes contenant des milliers d'intakes sans pénalité de performance et sans risque de doublon en cas de création concurrente.

GET/v1/intakesListe les intakes du compte, triés du plus récent au plus ancien, avec pagination par curseur et filtre optionnel sur l'état actif.

L'appel requiert une clé serveur (<code>cof_live_</code>, <code>cof_test_</code> ou <code>cof_sandbox_</code>) portant le scope <code>intake_read</code>. Les clés publishable (<code>cip_</code>) sont rejetées : la liste des intakes est une vue administrative, jamais exposée au navigateur. Aucun corps n'est attendu, tous les paramètres passent en query string.

Paramètres

Tous les paramètres sont optionnels. Sans aucun argument, vous récupérez la première page contenant jusqu'à dix intakes, du plus récent au plus ancien.

Paramètre	Type	Description
limit	integer	Nombre maximum d'intakes à renvoyer, entre 1 et 100. Valeur par défaut 10.
cursor	string	Curseur opaque renvoyé dans le champ next_cursor de la réponse précédente. Pointez vers la page suivante en le repassant tel quel.
enabled	boolean	Filtre sur l'état actif. true ne renvoie que les intakes acceptant des dépôts, false renvoie uniquement les intakes mis en pause.

Réponse

La réponse renvoie un objet enveloppe contenant le tableau <code>data</code> et les métadonnées de pagination. Le champ <code>object</code> vaut toujours la chaîne <code>list</code>, ce qui vous permet de réutiliser un parseur générique pour toutes les ressources listables de l'API.

Champ	Type	Description
object	string	Toujours "list" pour une réponse paginée.
data	array	Tableau d'objets Intake triés par date de création décroissante.
has_more	boolean	true s'il existe une page suivante, false si vous avez atteint la fin.
next_cursor	string ou null	Curseur à fournir pour la page suivante. Vaut null lorsque has_more est false.
limit	integer	Limite effectivement appliquée à cette requête.

Codes de statut

Code	Signification	Cause typique
200	OK	La liste a été renvoyée, même vide. data peut être un tableau vide sans qu'il s'agisse d'une erreur.
400	bad_request	Paramètre invalide (limit hors plage, cursor mal formé, enabled non booléen).
401	unauthorized	Clé absente, expirée ou révoquée.
403	forbidden	La clé ne porte pas le scope intake_read, ou il s'agit d'une clé publishable.
429	rate_limited	Quota dépassé. Respectez l'en-tête Retry-After avant de réessayer.
500	server_error	Incident côté Coffrify. Réessayez avec une stratégie de backoff.

Exemple de requête

L'exemple suivant récupère les vingt intakes actifs les plus récents. Pour parcourir l'intégralité du compte, rappelez le même endpoint en injectant la valeur de <code>next_cursor</code> dans le paramètre <code>cursor</code> jusqu'à ce que <code>has_more</code> bascule à <code>false</code>.

curl https://api.coffrify.com/v1/intakes \
  -G \
  --data-urlencode "limit=20" \
  --data-urlencode "enabled=true" \
  -H "Authorization: Bearer $COFFRIFY_API_KEY"

Exemple de réponse

Chaque objet du tableau <code>data</code> reprend la structure renvoyée par <code>GET /v1/intakes/{id}</code>, à l'exception de la <code>publishable_key</code> qui n'apparaît jamais en clair dans une liste. Pour récupérer une clé publishable existante, créez un nouvel intake ou faites tourner la clé via le tableau de bord.

{
  "object": "list",
  "data": [
    {
      "id": "in_8f3kQzPbN2vWxYr4",
      "object": "intake",
      "name": "Dossiers clients 2026",
      "slug": "dossiers-clients-2026",
      "allowed_origins": ["https://etude-martin.fr"],
      "metadata_policy": "allow",
      "reference_required": true,
      "enabled": true,
      "created_at": "2026-06-09T14:22:11Z"
    },
    {
      "id": "in_a1b2c3d4e5f6g7h8",
      "object": "intake",
      "name": "Pièces RH candidats",
      "slug": "rh-candidats",
      "allowed_origins": ["https://carrieres.example.com"],
      "metadata_policy": "strip",
      "reference_required": false,
      "enabled": true,
      "created_at": "2026-05-28T09:05:42Z"
    }
  ],
  "has_more": true,
  "next_cursor": "Y3Vyc29yOjE3MTcyMzA4MDIw",
  "limit": 20
}