Get all bank accounts

GET /api/v2/bank-accounts
Personal access token & O auth2

This endpoint will return all bank accounts in the firm relevant to the user accessing them.

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [accounts].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[account_uuids] string

    Filter by a comma separated list of account UUIDs.

  • filter[circle_uuids] string

    Filter by a comma separated list of circle UUIDs.

  • filter[account_name] string

    Filter by name.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, account_name]. Negative sign to denote DESC. Defaults to 'created_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • account_name string
      • account_holders string
      • account_number string
      • sort_code string
      • accounts object
        Hide accounts attributes Show accounts attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email string
        • photo_url string
        • external_references string
GET /api/v2/bank-accounts 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/bank-accounts' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "1bd947b7-9920-435a-94c5-1337e2edf5d6",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "83955e68-3391-49bf-927a-cbf1ab8cb91d",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-06-26T11:37:11+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-26T11:37:11+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "sort_code": "123456",
      "created_at": "2025-06-26T11:37:11+01:00",
      "updated_at": "2025-06-26T11:37:11+01:00",
      "account_name": "Savings Account",
      "account_number": "12345678",
      "account_holders": "Mr John A Smith"
    }
  ]
}