Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Your project's secret key (pk_…, without the pub segment). Server-side only — never ship it to a browser. Get it from Settings → Projects in the dashboard.

Query Parameters

q
string

Case-insensitive substring match on the external user id or stored trait JSON.

Maximum string length: 256
traitKey
string

Trait to filter on; must be provided together with traitValue.

Maximum string length: 200
traitValue
string

Exact match on a scalar trait's text form. Only stored string, number, or boolean values match; must be provided together with traitKey.

Maximum string length: 200
activeSince
string

Only users last seen at or after this instant. Epoch milliseconds or an ISO-8601 date.

firstSeenSince
string

Only users first seen at or after this instant. Epoch milliseconds or an ISO-8601 date.

page
integer
default:1

Page number.

Required range: x >= 1
perPage
integer
default:50

Items per page (max 100).

Required range: 1 <= x <= 100

Response

The project's users.

users
object[]
required
total
integer
required
Example:

412

page
integer
required
Example:

1

pageCount
integer
required
Example:

9