members

GET /v1/members/invitations

List pending member invitations in scope.

Tous les points de terminaison members

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation members.read ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Où insérer l'ID de votre organisation

Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

curl -X GET https://api.zinndigital.com/v1/members/invitations \
  -H "Authorization: Bearer zdk_live_…"

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

Returns the organization's **pending** invitations. Accepted/revoked invites are omitted. There is no secret in the payload — accept is authorized by the invitee's verified email (register #31). Requires `members.read`.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
org_id (query)UuidNonRestrict to one organization in scope (default — the whole subtree).
cursor (query)stringNonOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNonMaximum items to return (page size).

Réponse

NomTypeObligatoireQu'est-ce que c'est
dataInvitation[]Oui
pagePageMetaOui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 429