GET
/
domains
/
{domain}
/
mailboxes
curl --request GET \
  --url https://api.customeros.ai/domains/{domain}/mailboxes \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>'
{
  "mailboxes": [
    {
      "email": "<string>",
      "forwardingEnabled": true,
      "forwardingTo": [
        "<string>"
      ],
      "password": "<string>",
      "webmailEnabled": true
    }
  ],
  "requestId": "1234567890abcdef",
  "status": "success"
}

Authorizations

​
X-CUSTOMER-OS-API-KEY
string
header
required

Path Parameters

​
domain
string
required

Domain name

Response

200
application/json
Successfully retrieved mailboxes

Response containing list of mailboxes and status

​
mailboxes
object[]

List of mailboxes required: false

Comprehensive mailbox configuration and status

​
requestId
string
Example:

"1234567890abcdef"

​
status
string

Status indicates the result of the operation ("success" or "error")

Example:

"success"

Configure domain DNSCreate mailbox