Mailboxes

List mailboxes

Retrieves all mailboxes configured for the specified domain

get/domains/{domain}/mailboxes

Request

Base URL
https://api.customeros.ai
Auth
API key in header X-CUSTOMER-OS-API-KEY
TypeScript
https://skmtc.dev/customeros/apis/customeros-api/docs/domains/:domain/mailboxes/get.ts
A function with typed inputs. Its response is checked against the schema.

domainstring required

Domain name

Successfully retrieved mailboxes

requestIdstring

statusstring

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

{
  "requestId": "1234567890abcdef",
  "status": "success"
}

Jul 17, 202673526747b270 Revision changes
- info
  endpoint added
Sep 10, 20241ee4ed170cfa Revision changes
- breaking
  api path removed without deprecation