Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Mailboxes

List mailbox grants

Returns who can use the mailbox, what each grant allows, and whether its sends wait for approval, newest first.

GET
/v1/mailboxes/{id}/grants

Returns who can use the mailbox, what each grant allows, and whether its sends wait for approval, newest first. Pass nextCursor back as cursor for the next page; it is null on the last page.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$

Query Parameters

limit?string|null
cursor?CursorEncoded|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/mailboxes/string/grants"
{  "items": [    {      "id": "string",      "actor": {        "kind": "user",        "id": "string",        "displayName": "string"      },      "permissions": [        "mailbox:read"      ],      "sendMode": "send",      "createdAt": "string"    }  ],  "nextCursor": "string"}

Related documentation

List mailbox folders

Returns each folder that holds a thread with its thread count and the caller's unread count. The folder set is fixed, so the list is never paged.

List mailbox labels

Returns every label defined on a mailbox, ordered by name. A mailbox holds at most 100 labels, so the list is never paged.