Skip to main content
GET
Get email sync status for an account

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

accountId
string
required

Internal _id of the EmailAccount to query.

Response

Sync status returned

Response from GET /api/email/messages/sync/status.

accountId
string

The account this status belongs to.

inProgress
boolean

True while a historical sync is currently running.

lastSyncedAt
string<date-time> | null

Timestamp of the most recent successful sync, or null if none has completed.

messagesProcessed
integer

Cumulative count of messages persisted by the latest sync run.

totalEstimated
integer | null

Best-effort estimate of total messages the sync will touch, or null when the provider does not expose a count.

error
string | null

Last error message if the most recent run failed; otherwise omitted.