Get a Mail account

GET

/api/v1/mail/accounts/{id}

const url = 'https://example.com/api/v1/mail/accounts/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/mail/accounts/example \
  --header 'Authorization: Bearer <token>'

Requires a signed-in User. It returns the account settings and sync state. It returns 404 when the account is missing. Route: /api/v1/mail/accounts/{id}. Inputs: id. Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

required

string

Responses

200

application/json

object

created_at

required

string

email

required

string

enabled

required

boolean

required

string

imap_host

required

string

imap_port

required

integer format: int32

imap_tls_mode

required

IMAP transport mode. Cleartext authentication is never allowed.

string

Allowed values: implicit starttls

integration_account

required

boolean

integration_account_id

Connected Account identity for a Mail cache projection (#407, DESIGN §49 I6).

string | null

last_attempt_at

string | null

last_error

string | null

last_sync_at

string | null

provider

required

string

Allowed values: gmail icloud fastmail custom

retry_after

string | null

smtp_host

required

string

smtp_port

required

integer format: int32

smtp_tls_mode

required

IMAP transport mode. Cleartext authentication is never allowed.

string

Allowed values: implicit starttls

smtp_username

required

string

username

required

string

Example

{
  "imap_tls_mode": "implicit",
  "provider": "gmail",
  "smtp_tls_mode": "implicit"
}

404

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}