List Users

gethttps://statsigapi.net/console/v1/users

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

pageinteger

Page number

include_stale_membersboolean

Whether to include stale company-user membership edges. Defaults to false, which returns only effective current members (matching the Settings UI).

Response

application/json
200· List users response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
userID[]stringrequired

The user's unique ID.

email[]stringrequired

The email address of the user.

firstName[]stringrequired

The user's first name.

lastName[]stringrequired

The user's last name.

role[]stringrequired

The user's role, which can be 'Admin', 'Read Only', 'Member', or any custom role name.

paginationobjectrequired

Pagination metadata for checking if there is next page for example.

400· Invalid request. Please check the request input and try again.
statusintegerrequired
messagestringrequired
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
messagestringrequired

Was this helpful?