Skip to main content
POST
email.workspace.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json

The body is of type object.

Response

The result

inboxCount
integer
required

Number of owned inboxes.

Required range: 0 <= x <= 9007199254740991
domainCount
integer
required

Number of owned domains.

Required range: 0 <= x <= 9007199254740991
canDelete
boolean
required

Whether there are no inboxes or domains left; deletion also needs platform retirement support.

createdAt
string

Workspace creation time in UTC.

updatedAt
string

Last change in UTC.