Skip to main content

​
Endpoint

GET /api/v1/accounts
Retrieve all accounts for the authenticated user with support for filtering, sorting, and optional balance calculation.

​
Query parameters

​
type
string
Filter accounts by type (e.g., checking, savings, credit)
​
q
string
Search accounts by name using case-insensitive pattern matching
​
is_active
boolean
default:"true"
Filter by active status. Accepts true, false, 1, or 0
​
is_default
boolean
default:"false"
Filter by default account status. Accepts true, false, 1, or 0
​
include_balance
boolean
default:"false"
Include calculated balance for each account. Requires as_of_date or defaults to today
​
as_of_date
string
Date for balance calculation in YYYY-MM-DD format. Only used when include_balance=true
​
ids
string
Comma-separated list of account UUIDs to filter by
​
fields
string
Comma-separated list of fields to return. Available fields: id, name, type, is_default, is_active, created_at
​
sort
string
default:"name"
Field to sort by. Options: name, created_at, type
​
order
string
default:"asc"
Sort order. Options: asc, desc
​
limit
integer
default:"100"
Maximum number of results to return (1-1000)
​
offset
integer
default:"0"
Number of results to skip for pagination
​
cursor
string
Cursor for pagination. Cannot be used with offset

​
Response fields

​
data
array
Array of account objects
​
id
string
Unique account identifier (UUID)
​
name
string
Account name
​
type
string
Account type (e.g., checking, savings, credit)
​
is_default
boolean
Whether this is the default account
​
is_active
boolean
Whether the account is active
​
created_at
string
Account creation timestamp (ISO 8601)
​
balance
number
Calculated account balance (only included when include_balance=true)
​
meta
object
Pagination and metadata
​
total
integer
Total number of matching accounts
​
returned
integer
Number of accounts returned in this response
​
limit
integer
Maximum results per page
​
offset
integer
Current offset
​
next_cursor
string | null
Cursor for the next page, or null if no more results
​
sort
string
Field used for sorting
​
order
string
Sort order applied
​
include_balance
boolean
Whether balances were included
​
as_of_date
string | null
Date used for balance calculation

​
Example request

curl -X GET "https://api.cashcat.app/api/v1/accounts?is_active=true&include_balance=true&as_of_date=2024-03-15" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Main Checking",
      "type": "checking",
      "is_default": true,
      "is_active": true,
      "created_at": "2024-01-01T12:00:00Z",
      "balance": 2500.75
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Savings Account",
      "type": "savings",
      "is_default": false,
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "balance": 10000.00
    }
  ],
  "meta": {
    "total": 2,
    "returned": 2,
    "limit": 100,
    "offset": 0,
    "next_cursor": null,
    "sort": "name",
    "order": "asc",
    "include_balance": true,
    "as_of_date": "2024-03-15"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us