Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

Environment ID

projectId
string
required

Project ID

Query Parameters

limit
integer
default:20

Max items per page (1-100, default 20).

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

Opaque page cursor — the cursor query value found inside a prior response's next/previous URL. Normally you never build this yourself: just GET those URLs as-is.

orderBy

Order by createdAt / -createdAt.

Available options:
createdAt,
-createdAt
expand

Inline: companies, memberships, memberships.company.

Available options:
companies,
memberships,
memberships.company
email
string<email>

Filter to a user with this email.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
companyId
string

Filter to users in this company.

segmentId
string

Filter to users in this segment.

createdAfter
string

Only items created at or after this time — ISO date or datetime WITH timezone. A date-only value starts at that day's first instant (UTC).

createdBefore
string

Only items created at or before this time — ISO date or datetime WITH timezone. A date-only value includes the ENTIRE day (up to its last instant, UTC).

Response

List of users

results
object[]
required
next
string | null
required

Full URL of the next page — request it as-is (it already carries cursor= and your query parameters). null = no further pages.

previous
string | null
required

Full URL of the previous page — request it as-is. null = already at the first page.