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 ID of the account, which will look like biz_*************. Optional for account API keys; required for credentials that can access multiple accounts.

from
string<date-time>

Start of the time range as an ISO 8601 timestamp. Defaults to 366 days before to.

to
string<date-time>

End of the time range as an ISO 8601 timestamp. Defaults to now.

first
integer

The number of people to return (default 100, max 100).

after
string

A cursor for fetching people after a previous page.

before
string

A cursor for fetching people before a later page.

sort
string

Column to sort by (e.g. last_seen_at, ltv, purchase_count). Defaults to last_seen_at.

direction
enum<string>

Sort direction. Defaults to desc.

Available options:
asc,
desc
filters
string

A JSON-encoded array of filters, each with field, operator, and value keys.

Response

people listed

data
object[]
required
page_info
object
required
total_count
integer