Get Mirror Sync Status
GET/api/xero/v2/sync-status
Per-entity telemetry for the Xero mirror sync — when bank transactions and payments were last pulled from Xero, the incremental cursor position, and the most recent failure (if any).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Fields per entity (bank_transactions, payments):
cursor_at— incremental watermark: everything changed in Xero at/before this timestamp has been mirroredlast_sync_started_at/last_sync_completed_at— most recent scheduled runenabled— whether the nightly scheduled sync is turned on for this entity (opt-in per connection, via the accounting sync settings)last_sync_failed_at/last_sync_error— populated when the most recent attempt failed; cleared by the next successful run
All fields are null for an account that has never synced.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.