Get Plaid sync status for a bank account
Returns the current Plaid connection health for the bank account, resolved from the Plaid item single source of truth.
plaid_item_id and plaid_account_id are read-only and managed by the
connector. The Plaid access token is NEVER returned.
sync_status values:
active— the bank login works and the feed can import transactions.login_required— the bank login is dead. The operator must reconnect it (Plaid Link update mode) before the feed resumes. Checkitem_last_errorfor the reason Plaid gave.removed— the bank login was disconnected.legacy— Plaid-linked, but linked before the item SSOT existed. Automatic sync is off; manual sync still works.not_connected— no Plaid feed is linked to this bank account.
A feed can also be blocked while sync_status is active: check
feed_hold (the whole login is paused) and account_feed_enabled (this
specific sub-account is switched off).
Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Path Parameters
Response
Plaid status
The bank account id.
Feed health, derived from the Plaid item SSOT.
active, login_required, removed, legacy, not_connected The Plaid error code behind an unhealthy feed (for example
ITEM_LOGIN_REQUIRED, PENDING_EXPIRATION), or null.
Reserved. Always null: Plaid exposes no feed-expiry instant, so no value is inferred. Do not depend on this field.
Whether the bank account itself is active.
Raw Plaid item status, or null when no item backs this bank
account (legacy / not_connected).
active, login_required, removed, null The last failure Plaid reported for this item, formatted as "CODE: message".
True when ingestion is paused for the whole bank login.
False when this specific sub-account feed is switched off.
True when the operator needs to reconnect the bank login. Also
true for Plaid's 7-day advance warnings (PENDING_EXPIRATION,
PENDING_DISCONNECT) while the feed is still running.

