Skip to main content
GET
/
api
/
email
/
messages
/
sync
/
status
Get email sync status for an account
curl --request GET \
  --url https://your-instance.example.com/api/email/messages/sync/status \
  --header 'Authorization: Bearer <token>'
{
  "accountId": "665f1a0c0e0a4b001a2c9f50",
  "inProgress": false,
  "lastSyncedAt": "2026-05-18T12:00:00.000Z",
  "messagesProcessed": 423,
  "totalEstimated": 423,
  "error": null
}

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.