---
title: "Get Connected Accounts"
method: GET
path: "/v3/connected-accounts"
tags: ["Accounts"]
---

# Get Connected Accounts

`GET /v3/connected-accounts`

## Request

- Base URL: `https://api.truelayer-sandbox.com`
- URL: `https://api.truelayer-sandbox.com/v3/connected-accounts`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.truelayer.com/connect/token` scopes: `data`

Lists all connected accounts.

This API must be called using a `client_credentials` bearer token.

The endpoint returns a maximum of 50 items. Pagination will be supported in the future.

Items are ordered by `type` ascending, then `id` ascending.

## Query parameters

- `cursor` string: Cursor used for pagination purposes that represents the first item of the page. Returned as `next_cursor` in the response payload of endpoints supporting pagination. Not required to access the first page of items.
- `type` 'account' | 'card'

## Headers

- `Connection-Id` string, required
- `Tl-User-IP` string

## Response `200`

Accounts

- GetConnectedAccounts
  - `items` union[], required: List of connected accounts and cards. Ordered by `type` ascending, then `id` ascending.
    - union
      - Account
        - `id` string, required: The unique identifier of the account.
        - `type` 'account', required: Discriminator field identifying the account type.
        - `currency` string, required: Specified as a 3-letter ISO 4217 currency code.
        - `account_type` 'current' | 'savings'
        - `customer_segment` 'retail' | 'business'
        - `account_identifiers` AccountIdentifier[], required
          - union: A unique scheme identifier for an external account.
            - AccountIdentifierScan: The scheme identifier for a bank account participating in UK payment schemes.
              - …
            - AccountIdentifierIban: The international bank account number.
              - …
        - `bic` string: The Business Identifier Code (BIC) of the account.
        - `account_holder_names` string[], required: The names of the account holders. May be empty if not provided by the bank.
      - Card
        - `id` string, required: The unique identifier of the account.
        - `type` 'card', required: Identifies this item as a card. Additional card-specific fields (e.g. `card_network`, `card_type`, `partial_card_number`) will be added here when card support is introduced in a future release.
  - `pagination` Pagination, required: Pagination object. Optional next cursor to use as query parameters to fetch the page next to the one fetched.
    - `next_cursor` string: Cursor to be used as `cursor` query parameter to fetch the _next page_ in pagination-ready endpoints.

## Other responses

- `400`: Invalid Request
- `401`: Unauthenticated
- `403`: Forbidden
- `404`: Not Found
- `429`: Rate Limit Exceeded
- `500`: Unknown Error
- `502`: Provider Error
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/truelayer/apis/data-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/data-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/data-api-v3/revisions/ee1f295425a0?raw)