Get a bank account

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

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • account_name string

      The name of the bank account

    • account_holders string

      The name of the bank account holder(s) as it appears on statements

    • account_number string

      The bank account number

    • sort_code string

      The bank account sort code

    • accounts object

      The accounts linked to this bank account

      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/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/bank-accounts/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "uuid": "8dc4c3ba-d7fc-45c7-b63c-64c15cb3720c",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "4595c6b3-4769-4ab0-b6a7-1f9fa2f1b19e",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-08-27T17:31:28+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-08-27T17:31:28+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "sort_code": "123456",
  "created_at": "2025-08-27T17:31:28+01:00",
  "updated_at": "2025-08-27T17:31:28+01:00",
  "account_name": "Savings Account",
  "account_number": "12345678",
  "account_holders": "Mr John A Smith"
}