HEhellosunset
Financial Accounts

List financial accounts

List all financial accounts and assets for a case.

get/cases/{case_id}/financial-accounts

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

type'bank_account' | 'debt' | 'insurance' | 'investment' | 'retirement' | 'property' | 'vehicle' | 'business' | 'unclaimed_money'

Filter by account type.

institution_namestring

Partial match on institution name.

sort_by'balance' | 'type' | 'created_at'
sort_order'asc' | 'desc'

Sort direction.

Response

List of financial accounts.

Example response

{
  "data": [
    {
      "id": "01K5XA09BJ4T11HRYE78AN7ABC",
      "type": "bank_account",
      "institution_name": "Chase Bank",
      "account_number": "***1234",
      "balance": 15230.5,
      "details": "Joint checking account",
      "user_notes": "Need to contact branch for paperwork"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.