Skip to Content
SendlySendly
API ReferenceMailboxes

List mailboxes

GET
/api/mailboxes

Every mailbox on the authenticated project's domains, newest first. Not paginated: a project is capped at ten mailboxes, and the cap counts only those holding — or on their way to holding — a real account (PROVISIONING, ACTIVE, SUSPENDED). FAILED rows do not consume the cap but ARE returned here, so a project that has had failed provisions can list more than ten.

This lists the mailboxes themselves, never their contents: the messages a mailbox has received are not part of the public API and are not covered by this scope.

Requires the mailboxes:read scope — View the mailboxes on your domains and their settings.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

Response Body

Mailbox list

application/json
  1. response
success*true
Value intrue
data*array<>
Example Request
curl -X GET 'https://api.sendly.now/api/mailboxes'
Example Response
{  "success": true,  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "address": "user@example.com",      "displayName": "string",      "status": "PROVISIONING",      "quotaBytes": 0,      "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}