Saltar para a documentação
API

Listar convites pendentes

Os convites que ninguém aceitou ainda, por e-mail.

GETapi.openemail.uk/members/invitations

Executa a chamada real contra o seu espaço de trabalho, com a sua própria chave.

GET /members/invitations

Os convites que ninguém aceitou ainda, por e-mail.

Exemplo

Precisa de members:read. Cada um traz a função e os endereços e domínios inteiros que concede depois de aceite, quando expira e se o último e-mail lhes chegou. Paginado como qualquer outra lista: limit e cursor à entrada, hasMore e nextCursor à saída.

curl
curl "$OE/members/invitations" -H "$AUTH"
Resposta
{  "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}

Um convite pendente não concede nada. Um expirado fica nesta lista com expired: true até ser enviado de novo, o que o renova, ou retirado.

delivered é false quando o e-mail não saiu do servidor de correio, com o motivo em deliveryError, e null quando não foi registado nenhum resultado do último envio.

Uma chave limitada a determinados endereços ou domínios só lista os convites que não concedem nada fora deles.