Connections

List all financial connections

Returns a paginated list of the authenticated user's financial connections.

GET

/finance/connections

curl --request GET \
  --url https://api.synci.io/api/v1/finance/connections \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "access_valid_for_days": "<string>",
      "accounts_last_synced_at": "<string>",
      "activated_at": "<string>",
      "consent_expires_at": "<string>",
      "created_at": "<string>",
      "enabled": "<string>",
      "financial_accounts": [
        {
          "account_category": "<string>",
          "account_number_masked": "<string>",
          "account_usage": "<string>",
          "balance": {
            "available": "<string>",
            "cleared": "<string>"
          },
          "balances_last_synced_at": "<string>",
          "bban": "<string>",
          "bic": "<string>",
          "cash_account_type": "<string>",
          "cash_balance": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "config": {
            "enrichment": {
              "country": "<string>",
              "enabled": "<string>",
              "provider": "<string>"
            },
            "fields_for_duplicate_filtering": [
              "<string>"
            ],
            "fuzzy_counterparty_matching": "<string>",
            "fuzzy_counterparty_min_chars": "<string>",
            "map_fields": {
              "date": "<string>",
              "description": "<string>",
              "payee": "<string>"
            },
            "pending_settlement_matching": "<string>",
            "pending_settlement_max_days": "<string>",
            "sync_auto": "<string>",
            "sync_balances": "<string>",
            "sync_frequency_in_minutes": "<string>",
            "sync_pending_transactions": "<string>",
            "sync_start_date": "2025-01-01"
          },
          "created_at": "<string>",
          "currency": "<string>",
          "custom_name": "<string>",
          "details": "<string>",
          "details_last_synced_at": "<string>",
          "display_name": "<string>",
          "enabled": "<string>",
          "financial_connection": {},
          "financial_connection_id": "<string>",
          "health": {
            "failure_count": "<string>",
            "integrator_message": "<string>",
            "last_attempt_at": "<string>",
            "status": "<string>",
            "transient_failure_count": "<string>",
            "transient_message": "<string>"
          },
          "iban": "<string>",
          "id": "<string>",
          "institution_id": "<string>",
          "integrator": "<string>",
          "integrator_id": "<string>",
          "linked_accounts": "<string>",
          "meta": "<string>",
          "msisdn": "<string>",
          "name": "<string>",
          "owner_address": "<string>",
          "owner_name": "<string>",
          "product_name": "<string>",
          "raw_type": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

If you include financial_accounts in your request, Synci will omit sensitive financial account/card number identifiers, and certain direct identifiers from the response. Currently, the following fields will be omitted: iban, bban, scan, owner_name, owner_address, bic, msisdn, account_number_masked, integrator_id, institution_id.

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[institution_id]stringquery

filter[agreement_id]stringquery

filter[requisition_id]stringquery

filter[status]stringquery

filter[reference]stringquery

Filter by the caller-supplied correlation id set at creation (e.g. a platform developer's own end-user id): ?filter[reference]=my-user-123

filter[search]stringquery

Free-text search over the institution name and the reference (partial, case-insensitive) — same semantics as filter[search] on /finance/transactions.

filter[integrator]stringquery

Filter by the connection's provider directly. Accepts a single value or comma-separated list: ?filter[integrator]=GOCARDLESS ?filter[integrator]=GOCARDLESS,AKAHU

filter[category]stringquery

Filter by the institution's category. SnapTrade institutions are categorized as BROKERAGE or CRYPTO; bank institutions have no category. ?filter[category]=BROKERAGE ?filter[category]=CRYPTO

filter[domain]stringquery

Filter by data domain. ?filter[domain]=bank → bank connections (GoCardless, Akahu, demo banks) ?filter[domain]=asset → investment connections (SnapTrade) Lists come from IntegratorEnum so a new provider lands here automatically. DEMO belongs in bank: this filter answers "which of my connections are banks, not brokerages", and a connection the user deliberately made to a demo bank is one of their bank connections. (The institutions endpoint's identically-named filter deliberately answers a different question: see the note there.)

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of FinancialConnectionResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team

Authorizations

Query Parameters

Response