Get Connection Status

GET 
/api/accounting/sync-settings/connection

Reports whether the accounting connection is currently able to sync, and what is blocking it when it is not.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token

Two independent things must both hold before any document syncs to the accounting provider:

1. The connection is authorized — sync_status is Active. It flips to Inactive automatically when the provider rejects the stored authorization.
2. At least one transaction type is enabled — see GET /api/accounting/sync-settings.

blocker names whichever to fix first, in that order:

• connection_inactive — the authorization is dead, which makes every per-type toggle moot. Repair it with POST /api/accounting/sync-settings/connection.
• no_types_enabled — the connection is healthy but nothing is selected to sync. Enable types with PUT /api/accounting/sync-settings.
• null — nothing is blocking sync.

types_enabled / types_total count the per-type controls, so 0 of 24 and 23 of 24 are distinguishable states rather than one undifferentiated "paused".

This endpoint is read-only — it never changes the connection.

Returns 404 when no accounting integration is configured.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not Found

Response Headers

Content-Type

429

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.