Se connecterCommencer gratuitement
Référence APILister les approbateurs d'un transfert
GET/v1/transfers/{id}/approvers

Lister les approbateurs d'un transfert

Renvoie la liste des approbateurs attachés à un transfert, avec leur décision et leurs horodatages.

1 min de lectureTélécharger en PDF

Réponse exemple

{
  "data": [
    {
      "id": "tap_5f3a9c21b8e74d2a",
      "note": "OK pour diffusion au client.",
      "decision": "approved",
      "created_at": "2026-06-02T14:05:00.000Z",
      "decided_at": "2026-06-03T09:42:11.000Z",
      "notified_at": "2026-06-02T14:05:00.000Z",
      "transfer_id": "trf_8c1d4e90",
      "workspace_id": "ws_3a7b2f10",
      "approver_email": "directrice@acme.fr",
      "approver_user_id": "usr_9d4c1a22"
    },
    {
      "id": "tap_71b0e8f4a2c9476d",
      "note": null,
      "decision": "pending",
      "created_at": "2026-06-02T14:05:01.000Z",
      "decided_at": null,
      "notified_at": "2026-06-02T14:05:01.000Z",
      "transfer_id": "trf_8c1d4e90",
      "workspace_id": "ws_3a7b2f10",
      "approver_email": "juridique@acme.fr",
      "approver_user_id": null
    }
  ],
  "object": "list"
}
GET/v1/transfers/{id}/approversListe les approbateurs d'un transfert donné.

Cet endpoint retourne tous les approbateurs rattachés au transfert identifié par {id}, triés par date de création croissante (created_at ascendant). Avant de lire les approbateurs, l'API vérifie que le transfert appartient bien à l'espace de travail (workspace_id) lié à votre clé API : si le transfert n'existe pas dans cet espace, une erreur 404 est renvoyée. La liste inclut aussi bien les approbateurs déjà décisionnaires que ceux encore en attente.

Authentification

Cet endpoint nécessite une clé API valide disposant du scope transfers:manage. Une clé sans ce scope reçoit une erreur 403 scope_missing. La portée est implicitement limitée à l'espace de travail de la clé : vous ne pouvez lister que les approbateurs des transferts de votre propre espace.

Paramètres de requête

Cet endpoint n'accepte aucun paramètre de requête (query string). L'identifiant du transfert est passé directement dans le chemin de l'URL.

ParamètreEmplacementRequisDescription
idChemin (path)OuiIdentifiant du transfert dont on veut lister les approbateurs.

Réponse

La réponse est un objet liste : object vaut "list" et data contient le tableau des approbateurs (vide si aucun). Chaque approbateur expose : id, transfer_id, workspace_id, approver_user_id (utilisateur interne lié, ou null), approver_email, decision (par exemple pending, approved), decided_at, note, notified_at (horodatage de l'envoi de la notification, ou null) et created_at.

ChampTypeDescription
idstringIdentifiant de la ligne d'approbateur.
transfer_idstringIdentifiant du transfert associé.
workspace_idstringEspace de travail propriétaire.
approver_user_idstring | nullUtilisateur interne approbateur, ou null si invité par e-mail.
approver_emailstring | nullAdresse e-mail de l'approbateur.
decisionstringÉtat de la décision (ex. pending, approved).
decided_atstring | nullHorodatage ISO de la décision, ou null.
notestring | nullCommentaire laissé lors de la décision.
notified_atstring | nullHorodatage d'envoi de la notification.
created_atstringHorodatage de création de la ligne.

Erreurs

CodeQuandRésolution
401 missing_api_keyEn-tête Authorization absent.Ajoutez Authorization: Bearer cof_live_....
401 invalid_api_keyClé API invalide ou mauvais préfixe.Vérifiez la clé et son environnement (live/test).
403 scope_missingLa clé n'a pas le scope transfers:manage.Émettez une clé incluant ce scope.
404 not_foundLe transfert n'existe pas dans cet espace.Vérifiez l'id et l'espace de travail de la clé.
429 rate_limitedQuota de requêtes dépassé.Respectez l'en-tête Retry-After avant de réessayer.
500 internal_errorErreur côté base de données.Réessayez ; persistant, contactez le support avec le request_id.

Voir aussi