members
GET /v1/members/invitations
List pending member invitations in scope.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão members.read; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/members/invitations \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | Restrict to one organization in scope (default — the whole subtree). |
cursor (query) | string | Não | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Não | Maximum items to return (page size). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
data | Invitation[] | Sim | — |
page | PageMeta | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 429