Skip to the documentation
API

List who reaches an address

Everybody who can read the mail of an address, and how each one reaches it.

GET/domains/{id}/addresses/{addressId}/members

Runs the real call on your workspace.

GET /domains/{id}/addresses/{addressId}/members

Everybody who can read the mail of an address, and how each one reaches it.

Example

Needs members:read. via is owner, every-address for a role that reaches every address, whole-domain for a grant of the domain named in viaDomain, or direct for a grant of the address itself.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/members" -H "$AUTH"
Response
{  "object": "list",  "data": [    {      "object": "address_member",      "userId": "q7Vd3kX9mT2pLw8RzN4bYc6HfJ1sGa5E",      "email": "[email protected]",      "name": "Ana Lima",      "image": null,      "access": "member",      "via": "owner",      "viaDomain": null,      "removable": false    },    {      "object": "address_member",      "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t",      "email": "[email protected]",      "name": "Sam Okafor",      "image": null,      "access": "viewer",      "via": "direct",      "viaDomain": null,      "removable": true    }  ]}

Each person appears once. access is member for somebody who reads the address and sends from it, and viewer for somebody who only reads it.

Only a grant of the address itself is removable, with DELETE /members/{userId}/addresses/{addressId}. The others change with the role or the domain grant behind them.

Reference