THthredfi
Bank Accounts Management

List Bank Account Connections

    Retrieve a paginated list of bank account connections with advanced filtering options and statistics.

    **Default Behavior:**
    - Returns all bank account connections for the authenticated partner's businesses
    - Uses summary serializer for list view (lighter payload)
    - Includes statistics for the filtered results

    **Statistics Included:**
    - Total account counts (total, active, inactive)
    - Sync status counts (synced, never synced)
    - Mapping status counts (mapped, unmapped)
    - Provider breakdown
    - Currency breakdown
    - Balance summary (total, average, min, max, account counts)

    **Filtering Options:**

    **Status Filters:**
    - `is_active`: Filter by active status (true/false)

    **Provider & Business Filters:**
    - `provider`: Filter by provider (e.g., 'plaid')
    - `bank_link_status`: Filter by bank link status
    - `business_id`: Filter by specific business UUID
    - `business_name`: Search business names

    **Account Filters:**
    - `currency`: Filter by currency code (USD, EUR, etc.)
    - `balance_min`: Minimum balance filter
    - `balance_max`: Maximum balance filter
    - `has_mapped_account`: Filter by whether account is mapped to chart of accounts
    - `mapped_account_id`: Filter by specific mapped account ID

    **Date Filters:**
    - `updated_after`: Accounts updated after date
    - `updated_before`: Accounts updated before date
    - `first_sync_after`: Accounts first synced after date
    - `first_sync_before`: Accounts first synced before date
    - `has_been_synced`: Filter by whether account has been synced

    **Search:**
    - `search`: Search across account names, keys, masks, and business names

    **Ordering:**
    - `ordering`: Order by any field (prefix with '-' for descending)
    - Default: `-created_at` (newest first)

    **Examples:**
    - Get all active accounts: `?is_active=true`
    - Get accounts for specific business: `?business_id=123e4567-e89b-12d3-a456-426614174000`
    - Get accounts that have been synced: `?has_been_synced=true`
    - Get mapped accounts: `?has_mapped_account=true`
    - Search for accounts: `?search=checking`
    - Order by balance: `?ordering=-balance`
get/v1/platform/businesses/{business_id}/bank-accounts/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

business_idstring uuid required

Query parameters

account_keystring

Filter by account key (partial match)

balance_maxnumber double

Filter by maximum balance

balance_minnumber double

Filter by minimum balance

bank_link_status'active' | 'error' | 'revoked'

Filter by bank link status

business_idstring

Filter by business ID (UUID format)

business_namestring

Filter by business name (partial match)

currencystring

Filter by currency code (USD, EUR, etc.)

display_namestring

Filter by display name (exact, case-insensitive)

first_sync_afterstring date-time

Filter accounts first synced after this date

first_sync_beforestring date-time

Filter accounts first synced before this date

has_been_syncedboolean

Filter by whether account has been synced (true for synced, false for never synced)

has_mapped_accountboolean

Filter by whether account is mapped (true for mapped, false for unmapped)

is_activeboolean

Filter by active status

mapped_accountstring uuid
mapped_account_idstring uuid

Filter by mapped account ID

orderingstring

Order by field (prefix with - for descending)

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

providerstring

Filter by provider (e.g., plaid)

searchstring

Search in account names, keys, masks, and business names

updated_afterstring date-time

Filter accounts updated after this date

updated_beforestring date-time

Filter accounts updated before this date

Response

countinteger required

Total number of items

Example response

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.