Se connecterCommencer gratuitement
Référence APILister les invités d'un coffre
GET/v1/coffres/{id}/guests

Lister les invités d'un coffre

Renvoie tous les invités actifs (non révoqués) d'un coffre du workspace.

1 min de lectureTélécharger en PDF

Réponse exemple

{
  "guests": [
    {
      "id": "gst_8f3a21c0d4e9",
      "note": "Contact côté acquéreur",
      "email": "client@exemple.com",
      "status": "pending",
      "created_at": "2026-06-05T09:14:22.000Z",
      "expires_at": "2026-07-01T00:00:00.000Z",
      "can_download": true,
      "last_accessed_at": null
    }
  ]
}
GET/v1/coffres/{id}/guestsListe les invités actifs d'un coffre.

Renvoie la liste des invités rattachés au coffre identifié par {id}. L'endpoint vérifie d'abord que le coffre appartient bien au workspace de la clé API : si ce n'est pas le cas, il répond 404 plutôt que de divulguer l'existence du coffre. Les invités dont le statut est revoked sont exclus du résultat, et la liste est triée par date de création décroissante (les invitations les plus récentes en premier).

Authentification

Requiert une clé API valide portant le scope coffres:manage. Le scope est vérifié côté serveur via la table d'alias : un token disposant du wildcard coffres:* ou * satisfait également l'exigence. Cet endpoint est marqué skipIdempotency, ce qui est sans effet pour une lecture GET.

Paramètres de requête

Le seul paramètre est l'identifiant du coffre passé dans le chemin. Aucun paramètre de requête (query string) n'est lu par le handler.

ParamètreEmplacementRequisDescription
idChemin (path)OuiIdentifiant du coffre dont on liste les invités. Doit appartenir au workspace de la clé API.

Réponse

La réponse contient un unique tableau guests. Chaque invité expose : id, email, status (par ex. pending), can_download (booléen autorisant le téléchargement), note (annotation interne, nullable), expires_at (expiration de l'accès, nullable), last_accessed_at (dernier accès de l'invité, nullable) et created_at. Si le coffre n'a aucun invité actif, guests est un tableau vide.

Erreurs

CodeQuandRésolution
401 missing_api_keyAucun en-tête Authorization ni session valide.Envoyer Authorization: Bearer cof_live_....
401 invalid_api_keyPréfixe de clé inconnu ou clé introuvable.Vérifier la clé et son préfixe (cof_live_, cof_test_, ...).
403 scope_missingLa clé ne porte pas coffres:manage.Émettre une clé avec le scope coffres:manage.
404 not_foundLe coffre n'existe pas ou n'appartient pas au workspace.Vérifier l'identifiant {id} et le workspace de la clé.
429 rate_limitedQuota de requêtes par minute dépassé.Respecter l'en-tête Retry-After puis réessayer.
500 internal_errorErreur lors de la lecture en base.Réessayer ; contacter le support avec le request_id si cela persiste.

Voir aussi