Skip to main content
GET
List items in a list

Authorizations

Authorization
string
header
required

Send your workspace API key as a bearer token:

Keys are scoped to a single workspace. See Authentication.

Path Parameters

list_id
string
required

Query Parameters

period
enum<string>
default:last_30d

A named period. Mutually exclusive with period_start and period_end.

Available options:
last_7d,
last_30d,
last_90d,
last_180d,
month_to_date,
previous_month
currency
string
default:USD

Convert every monetary field to this ISO 4217 currency.

Examples:

"USD"

"GBP"

"IDR"

limit
integer
default:25

How many objects to return per page.

Required range: 1 <= x <= 100
cursor
string

The next_cursor from a previous response.

Response

List items.

object
string
required
Allowed value: "list"
has_more
boolean
required

Whether another page exists.

data
object[]
required

A normalized entity of the list's entity_type.

next_cursor
string | null

Pass to cursor to fetch the next page. Null on the last page.

total_count
integer | null

Approximate number of matches. Null when the result set is too large to count exactly.

period
object

The concrete window a request was measured over, after any preset was expanded and any channel-specific snapping was applied. Always read this rather than assuming you got back exactly the dates you asked for.

currency
string