Aller à la documentation
API

Lister les invitations en attente

Les invitations que personne n'a encore acceptées, par e-mail.

GETapi.openemail.uk/members/invitations

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

GET /members/invitations

Les invitations que personne n'a encore acceptées, par e-mail.

Exemple

Nécessite members:read. Chacune porte le rôle ainsi que les adresses et domaines entiers qu'elle accorde une fois acceptée, sa date d'expiration et si le dernier e-mail est arrivé. Paginée comme toute autre liste : limit et cursor en entrée, hasMore et nextCursor en sortie.

curl
curl "$OE/members/invitations" -H "$AUTH"
Réponse
{  "object": "list",  "data": [{      "object": "invitation",      "id": "winv_6bb640f5b99e47deb758f1f5",      "email": "[email protected]",      "role": {        "id": "role_2b81de079c1f0a4b7e05d386",        "name": "Support",        "builtin": null      },      "addresses": [],      "domains": [        {          "domainId": "93542ff8-2baa-4f2f-841d-5ceaa074ab0d",          "domain": "acme.com",          "access": "member"        }      ],      "expiresAt": "2026-10-07T09:12:40.000Z",      "expired": false,      "lastSentAt": "2026-09-23T09:12:40.000Z",      "delivered": true,      "deliveryError": null,      "createdAt": "2026-09-18T14:07:31.000Z"    }],  "hasMore": false,  "nextCursor": null}

Une invitation en attente n'accorde rien. Une invitation expirée reste sur cette liste avec expired: true jusqu'à ce qu'elle soit renvoyée, ce qui la renouvelle, ou retirée.

delivered vaut false quand l'e-mail n'a pas quitté le serveur de messagerie, avec la raison dans deliveryError, et null quand aucun résultat n'a été enregistré pour le dernier envoi.

Une clé limitée à certaines adresses ou certains domaines ne liste que les invitations qui n'accordent rien en dehors d'eux.