Skip to main content
GET
Get business email status

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Query Parameters

limit
integer
default:500

Entries per page, 1 to 500. Defaults to 500, which fits every entry.

Required range: 1 <= x <= 500
cursor
string

next_cursor from the previous page. Send it alone.

Response

The workspace's business email.

items
BusinessEmailMailbox · object[]
required

One entry per domain with business email on this page. With the default limit, every one. Empty when the workspace has none.

Example:
can_purchase
boolean
required

true when the workspace can buy business email. false when it has no billing account for business email, or its plan is paid through the App Store.

Example:

true

next_cursor
string | null
required

Send as cursor to get the next page. null on the last page.

Example:

"gAAAAABn7vJ0q2kX"