Search documentation
Fuzzy search across every docs page and section
API referenceItems
Fuzzy search across every docs page and section
API referenceItems
API reference
POST /v1/items/get, /v1/items/remove, /v1/items/refresh — inspect, disconnect, and refresh a connected institution login.
All endpoints are POST with a JSON body, authenticated with your secret key (Authentication). Errors use the standard envelope; money is in major units with an iso_currency_code; dates are YYYY-MM-DD strings.
An item is one user's connection to one institution — the thing an access_token points at. It owns accounts, transactions, and sync cursors.
/v1/items/getaccess_tokenstringrequiredcurl https://api.feelconnect.dev/v1/items/get \-H "Authorization: Bearer $FEELCONNECT_SECRET_KEY" \-H "Content-Type: application/json" \-d '{"access_token":"fc_at_…"}'
{"item": {"item_id": "item_7dJ3nWqZ5xC9vK1mTf4g","institution_id": "inst_meridian_trust","institution_name": "Meridian Trust","connector": "sandbox","status": "active","error": null,"consented_products": ["transactions","balances","recurring"],"last_successful_sync": "2026-07-27T06:00:41.000Z"}}
| Status | Meaning | What to do |
|---|---|---|
active | Healthy; data flows on schedule. | Nothing. |
login_required | The institution invalidated credentials. | Reopen Link in update mode. You also received item.error. |
error | A provider-side failure; error.code has details. | Retry later or relink; see error.message. |
removed | The item was removed via /items/remove. | The access token is dead. Relink to reconnect. |
/v1/items/removeDisconnects the item and invalidates its access token permanently. Emits an item.removed webhook. Remove items when a user disconnects an account or deletes their profile — it is the API form of consent revocation.
curl https://api.feelconnect.dev/v1/items/remove \-H "Authorization: Bearer $FEELCONNECT_SECRET_KEY" \-H "Content-Type: application/json" \-d '{"access_token":"fc_at_…"}'
{"removed": true}
/v1/items/refreshRequests an on-demand data refresh ahead of the normal schedule. Refresh is asynchronous: the call returns immediately and a transactions.sync_updates_available webhook fires when new data is ready.
curl https://api.feelconnect.dev/v1/items/refresh \-H "Authorization: Bearer $FEELCONNECT_SECRET_KEY" \-H "Content-Type: application/json" \-d '{"access_token":"fc_at_…"}'
{"refreshing": true}