Skip to main content
GET
List all financial connections

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

omit_sensitive_identifiers
boolean

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]
integer
default:25

The number of results that will be returned per page.

page[number]
integer

The page number to start the pagination from.

filter[institution_id]
string
filter[agreement_id]
string
filter[requisition_id]
string
filter[status]
string
filter[reference]
string

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

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

filter[integrator]
string

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

filter[category]
string

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]
string

Filter by data domain: bank returns bank connections (including demo banks), asset returns brokerage and crypto exchange connections.

sort
enum<string>[]
Available options:
id,
-id,
created_at,
-created_at,
updated_at,
-updated_at
include
enum<string>[]
Available options:
financial_accounts,
financial_accounts.transfer_links,
financial_accounts.rules,
institution,
financial_accounts_count

Response

Paginated set of FinancialConnectionResource

data
FinancialConnectionResource · object[]
required
meta
object
required