Skip to main content
GET
Get financial insights

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

Legal entity ID (le_…). Can be combined with legal_entity_ids.

Example:

"le_507f1f77bcf86cd799439011"

Legal entities to include (le_…). Omit to include all.

Maximum array length: 100

Legal entity ID (le_…).

account_ids
string[]

Comma-separated fac_ financial account IDs. Ignored when basis=ledger; meta.account_ids_ignored is then set.

start_date
string<date-time>
required

Inclusive interval start.

Example:

"2026-08-31T12:00:00Z"

end_date
string<date-time>
required

Inclusive interval end; start must not exceed end.

Example:

"2026-08-31T12:00:00Z"

metrics
enum<string>[]
required

Metrics to return.

Required array length: 1 - 7 elements

Metric identifier.

Available options:
revenue,
profit,
expenses,
spending,
burn_rate,
runway,
cash_flow
basis
enum<string>
required

Required. ledger for the posted books, or transactions for observed cash movements.

Available options:
ledger,
transactions
granularity
enum<string>

Bucket size. For basis=ledger, the response shows the monthly buckets used.

Available options:
daily,
weekly,
monthly

Response

The request succeeded.

Not paginated. Each item has its own meta. Burn rate and runway always use monthly buckets, whatever the granularity.

data
object[]
required

The records.