List Bank Account Connections

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-accounts/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "9f90c3cc-6i00-0h16-eeee-eii81402618g",
      "display_name": "Barclays Business Current Account",
      "official_name": "Barclays Bank PLC - Business Account",
      "mask": "1234",
      "balance": 12500.5,
      "balance_cents": 1250050,
      "currency": "GBP",
      "is_active": true,
      "bank_link_status": "active",
      "business_name": "The Red Lion Pub Ltd",
      "provider": "plaid",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Bank Accounts

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

platform

businesses

{business_id}

bank-accounts

List Bank Account Connections

curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/bank-accounts/ \
  --header 'Authorization: Bearer <token>'

{
  "count": 123,
  "page_info": {
    "total_count": 123,
    "current_page": 1,
    "total_pages": 7,
    "page_size": 20
  },
  "results": [
    {
      "id": "9f90c3cc-6i00-0h16-eeee-eii81402618g",
      "display_name": "Barclays Business Current Account",
      "official_name": "Barclays Bank PLC - Business Account",
      "mask": "1234",
      "balance": 12500.5,
      "balance_cents": 1250050,
      "currency": "GBP",
      "is_active": true,
      "bank_link_status": "active",
      "business_name": "The Red Lion Pub Ltd",
      "provider": "plaid",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Business-scoped JWT token. Token payload includes business_id to automatically scope requests. Format: Bearer <your-jwt-token>

Use this for: Business-specific operations where the business context is embedded in the token.

Path Parameters

business_id

string<uuid>

required

Query Parameters

account_key

string

Filter by account key (partial match)

balance_max

number<double>

Filter by maximum balance

balance_min

number<double>

Filter by minimum balance

bank_link_status

enum<string>

Filter by bank link status

Available options:

active,

error,

revoked

business_id

string

Filter by business ID (UUID format)

business_name

string

Filter by business name (partial match)

currency

string

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

display_name

string

Filter by display name (exact, case-insensitive)

first_sync_after

string<date-time>

Filter accounts first synced after this date

first_sync_before

string<date-time>

Filter accounts first synced before this date

has_been_synced

boolean

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

has_mapped_account

boolean

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

is_active

boolean

Filter by active status

mapped_account

string<uuid>

mapped_account_id

string<uuid>

Filter by mapped account ID

ordering

string

Order by field (prefix with - for descending)

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

provider

string

Filter by provider (e.g., plaid)

string

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

updated_after

string<date-time>

Filter accounts updated after this date

updated_before

string<date-time>

Filter accounts updated before this date

Response

count

integer

required

Total number of items

Example:

123

page_info

object

required

Show child attributes

Example:

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

results

object[]

required

Show child attributes

Update business Retrieve Bank Account Connection

⌘I

Managing Businesses

Importing Business Activity

Financial Reports

List Bank Account Connections

Authorizations

Path Parameters

Query Parameters

Response