Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Query Parameters

account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

include_owned_accounts
boolean

When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning account.

line_types
string[]

Optional ledger line categories to include. Some categories (for example onchain_deposit, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here.

currency
string

Optional currency code filter, for example usd.

posted_after
string<date-time>

Only include rows posted after this ISO 8601 timestamp.

posted_before
string<date-time>

Only include rows posted before this ISO 8601 timestamp.

available_after
string<date>

Only include rows whose funds became withdrawable on or after this YYYY-MM-DD settlement date (UTC), distinct from posted_at. Requires currency.

available_before
string<date>

Only include rows whose funds became withdrawable on or before this YYYY-MM-DD settlement date (UTC). Set equal to available_after for a single day. Requires currency.

limit
integer
default:20

Maximum number of rows to return.

Required range: x <= 100
cursor
string

Cursor returned by the previous page.

Response

activities listed for a user

data
object[]
required
page_info
object
required