---
title: "List connected accounts"
method: GET
path: "/connected_accounts"
tags: ["connected-accounts"]
---

# List connected accounts

`GET /connected_accounts`

List and filter connected accounts.

## Query parameters

- `limit` integer
- `starting_after` string
- `sort_order` 'asc' | 'desc'
- `start_date` string, date
- `end_date` string, date
- `enabled` boolean
- `bank_name` string
- `address.country` string

## Response `200`

List of filtered connected accounts.

- ConnectedAccountSearchResult
  - `records` ConnectedAccountDetails[], required
    - `id` string, required — The ID of the connected account.
    - `object` string, required — Type of the object, `connected_account`.
    - `type` 'financial_institution' | 'corporate', required — The type of the connected account: * `financial_institution`: * `corporate`:
    - `name` string, required — The name of the connected account.
    - `bank_code` string, required — The bank code of the connected account. It can be a BIC or a sort code.
    - `bank_name` string, required — Name of the bank to which this `connected_account` is linked.
    - `bank_address` ConnectedAccountAddress — A connected account address
      - `line_1` string, required — Address line number one.
      - `line_2` string, required — Address line number two.
      - `building_number` string — Address building number.
      - `street_name` string — Address street name.
      - `postal_code` string, required — Address postal code.
      - `region_state` string, required — Address region or state.
      - `city` string, required — Address city.
      - `country` string, required — Address country.
      - `room` string — Room number.
      - `floor` string — Floor number or identifier.
      - `postal_box` string — Postal box.
      - `department` string — Department name or code.
      - `sub_department` string — Sub-department name.
      - `building_name` string — Name of the building.
      - `district_name` string — District name or administrative region.
      - `city_location_name` string — Specific city location or landmark.
    - `creditor_identifier` string, required — The unique reference for organisations collecting payments by SEPA Direct Debit.
    - `legal_entity_identifier` string — The legal entity identifier (LEI) of the connected account.
    - `currency` string, iso-4217, required — The currency of the connected account, as an [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217).
    - `account_number` string, required — The account number of the connected account.
    - `account_number_format` 'iban' | 'uk_account_number' | 'us_account_number' | 'tokenized' | 'other' — The format of the account number.
    - `bank_code_format` 'bic' | 'uk_sorting_code' | 'us_aba_routing_number' | 'tokenized' | 'other' — The format of the bank code.
    - `services_activated` ConnectedAccountBankService[], required — The services activated for the connected account.
    - `file_auto_approval` boolean, required — When `file_auto_approval` is `true`, files related to this connected account get automatically approved. When `file_auto_approval` is `false`, files related to this connected account must be approved in order to be sent.
    - `address` ConnectedAccountAddress, required — A connected account address
      - `line_1` string, required — Address line number one.
      - `line_2` string, required — Address line number two.
      - `building_number` string — Address building number.
      - `street_name` string — Address street name.
      - `postal_code` string, required — Address postal code.
      - `region_state` string, required — Address region or state.
      - `city` string, required — Address city.
      - `country` string, required — Address country.
      - `room` string — Room number.
      - `floor` string — Floor number or identifier.
      - `postal_box` string — Postal box.
      - `department` string — Department name or code.
      - `sub_department` string — Sub-department name.
      - `building_name` string — Name of the building.
      - `district_name` string — District name or administrative region.
      - `city_location_name` string — Specific city location or landmark.
    - `metadata` object, required — Additional client data in JSON format. See [Metadata](https://docs.numeral.io/reference/metadata).
    - `custom_fields` CommonCustomFields, required — Custom fields in JSON `key:value` format. See [Custom fields](https://docs.numeral.io/reference/custom-fields).
    - `disabled_at` string, date-time, nullable, required
    - `created_at` string, date-time, required — 2022-06-17T08:49:54.54422Z
    - `bank_data` object — Bank data in JSON `key:value` format.
      - `external_id` string — The external ID of the connected account provided by the bank.

## Other responses

- `400` — Validation error.
- `500` — Internal server error.

---

[API](https://skmtc.net/numeral/apis/payments.md) · [All operations](https://skmtc.net/numeral/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/numeral/payments/revisions/220f101cc2ef/schema)