Skip to main content
GET
Get all users for an environment

Authorizations

Authorization
string
header
required

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

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

filter
object
orderBy
string

$COLUMN_NAME-asc|desc

Pattern: ^[A-Za-z]*-(asc|desc)$
Example:

"something-asc"

offset
integer
default:0

The number of items to skip before starting to collect the result set

Required range: x >= 0
limit
integer
default:20

The numbers of items to return

Required range: 1 <= x <= 100
includeSessions
boolean

When true, we will return the most recent list of sessions for each user in the list.

Response

List of users

count
integer
users
object[]
Last modified on January 21, 2026