Skip to main content
GET
Find users

Authorizations

Authorization
string
header
required

Path Parameters

projectKey
string<string>
required

The project key

environmentKey
string<string>
required

The environment key

Query Parameters

q
string<string>

Full-text search for users based on name, first name, last name, e-mail address, or key

limit
integer<int64>

Specifies the maximum number of items in the collection to return (max: 50, default: 20)

searchAfter
string<string>

Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the next link we provide instead.

filter
string<string>

A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue

Response

Users collection response

totalCount
integer
required

The total number of users in the environment

Example:

245

items
object[]
required

Details on the users

The location and content type of related resources

Example: