Get a bank account

GET /api/v2/bank-accounts/{id}

Personal access token & O auth2

Headers

Path parameters

id string Required

The ID of the bank account.

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_number string
  
  The bank account number
- sort_code string
  
  The bank account sort code
- accounts object
  
  The accounts linked to this bank account

GET /api/v2/bank-accounts/{id}

curl \
 --request GET 'https://api.plannrcrm.com/api/v2/bank-accounts/id' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "uuid": "1fdd16fd-db62-40f6-82a7-705606370911",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "7a64fe2e-9fb7-46c2-8a50-d7cc3be3756a",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-05-29T16:20:15+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-29T16:20:15+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "sort_code": "123456",
  "created_at": "2025-05-29T16:20:15+01:00",
  "updated_at": "2025-05-29T16:20:15+01:00",
  "account_name": "Savings Account",
  "account_number": "12345678"
}