Skip to main content
GET
Get an account

Authorizations

X-API-KEY
string
header
required

Your access token, from your dashboard under API keys.

Path Parameters

account_id
string
required

The account's acc_… id.

Response

The account.

object
string
Allowed value: "Account"
id
string

acc_…

user_id
string

The mailbox's email address.

name
string
provider
enum<string>

imap: Gmail, Google Workspace and every other provider through IMAP/SMTP.

Available options:
imap
status
enum<string>
  • running: connected and syncing.
  • errored: syncing keeps failing (server down, network); the engine retries by itself.
  • disconnected: the provider rejected the password or token (reconnect it), or the account is paused in the dashboard (is_locked: true).
Available options:
running,
errored,
disconnected
status_detail
string

The last error message

is_locked
boolean

Paused from the dashboard: not syncing.

initial_sync
object

Only on accounts connected with initial_sync_enable: true: the import of the mail already in the mailbox.

metadata
object

Your own key-value data.

connection_params
object

Connection settings, never passwords.

created_at
string<date-time>
last_synced_at
string<date-time> | null