Skip to main content
GET
List accounts

Authorizations

X-API-KEY
string
header
required

Your access token, from your dashboard under API keys.

Query Parameters

limit
integer
default:50

How many items per page, 1 to 250.

Required range: 1 <= x <= 250
offset
integer
default:0

How many items to skip.

Required range: x >= 0
status
enum<string>

Only accounts with this status.

  • 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
provider
enum<string>

Only accounts of this provider. imap: Gmail, Google Workspace and every other provider through IMAP/SMTP.

Available options:
imap

Matches the name or the email address (contains), or an exact acc_… id.

Response

The accounts.

object
string
Allowed value: "Accounts"
data
object[]
has_more
boolean

More accounts after this page (raise offset).