Saltar para a documentação
API

Obter um membro

Uma pessoa, a sua função e os seus endereços, por id de conta.

GETapi.openemail.uk/members/{userId}

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

GET /members/{userId}

Uma pessoa, a sua função e os seus endereços, por id de conta.

Exemplo

Requer members:read. Por ID DE UTILIZADOR: o userId da lista, não o endereço de email.

curl
curl "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t" -H "$AUTH"
Resposta
{  "object": "member",  "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t",  "email": "[email protected]",  "name": "Sam Okonjo",  "image": null,  "role": {    "id": "role_2b81de079c1f0a4b7e05d386",    "name": "Support",    "builtin": null  },  "implied": false,  "permissions": [    "emails:send",    "emails:read",    "threads:read",    "threads:write",    "labels:read",    "labels:write",    "contacts:read"  ],  "addresses": [    {      "addressId": "2b81de07-9c1f-4a4b-8e05-d3862c1f0a44",      "address": "[email protected]",      "access": "member"    }  ],  "createdAt": "2026-08-12T14:20:00.000Z"}

Aqui não há procura por email. POST /members é a única chamada que aceita um, porque é a única chamada cujo autor genuinamente ainda não tem um id de utilizador.

Um id de utilizador que não pertence a este espaço de trabalho é um 404 simples. É o único caso neste recurso que é inequivocamente "não existe tal recurso". A mesma condição levantada por uma escrita que não pôde ser relida corresponde a 422, o que ali está certo e aqui estaria errado.

Lido a partir da lista completa de membros em vez de por uma consulta de linha única, deliberadamente: um membro é a UNIÃO de uma linha de função e de um conjunto de concessões de endereço, qualquer uma das quais pode existir sem a outra, e essa união é calculada num único sítio. Uma consulta de linha única seria uma segunda implementação dela, e a população que deixaria passar em silêncio seria a dos detentores de concessões antigas, que hoje são a maior parte da tabela.