Retrieve Data

What It Does

Use read endpoints to retrieve ingested records for your API key.

Send logical table names such as clients, disbursements, payments, or operations; the API scopes the request to your data.

Authorization: Bearer YOUR_API_KEY

List Records

GET /api/tables/:table

Example:

GET /api/tables/payments?limit=25&sort_by=payment_date&sort_order=desc
Authorization: Bearer YOUR_API_KEY

Response:

{
  "data": [
    {
      "payment_id": "PAY-2024-001",
      "disbursement_id": "DSB-2024-001",
      "amount": 250,
      "currency": "USD"
    }
  ],
  "pagination": {
    "limit": 25,
    "has_more": false
  }
}

Query Parameters

Parameter	Notes
`limit`	Rows per page. Defaults to `50`.
`cursor`	Cursor from `pagination.next_cursor` to retrieve next page.
`sort_by`	Column to sort on. Defaults to `created_at`; `asset_status` and `disbursement_status` default to `on_date`.
`sort_order`	`asc` or `desc`. Defaults to `desc`.
`include_count`	Send `true` to include `total` and `total_pages`.
`date_field`	Column used by `start_date` and `end_date`. Required when either date filter is present.
`start_date`	Inclusive lower date bound for `date_field`.
`end_date`	Inclusive upper date bound for `date_field`.
`search`	Partial match across searchable ID/status columns for that table.

Get One Record

GET /api/tables/:table/:id

Example:

GET /api/tables/disbursements/DSB-2024-001
Authorization: Bearer YOUR_API_KEY

Response:

{
  "data": {
    "disbursement_id": "DSB-2024-001",
    "client_id": "BR-2024-001",
    "amount": 10000,
    "currency": "USD"
  }
}

The :id value uses the table primary key:

Allowed Tables

clients, disbursements, payments, operations, purchase_clients,

asset_status, disbursement_status,

write_offs, rebates , extensions , restructures

Errors

401 Invalid or missing API key: missing or invalid Authorization header.
400 Invalid table name: table is not in the allowlist.
400 date_field is required when using start_date or end_date: add date_field.
404 Record not found: no row exists for that table and ID.