List Users

Reference for the GET /console/v1/users endpoint of the Statsig API.

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

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

Example:10
Constraints:stringnumber
pageinteger

Page number

Example:1
Constraints:stringnumber
include_stale_membersboolean

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

Example:false

Response

application/json
200· List users response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
userIDstringrequired

The user's unique ID.

emailstringrequired

The email address of the user.

Constraints:format: email
firstNamestringrequired

The user's first name.

lastNamestringrequired

The user's last name.

rolestringrequired

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.

Show child attributes
itemsPerPagenumberrequired
Constraints:format: double
pageNumbernumberrequired
Constraints:format: double
nextPagestringrequired
Constraints:nullable
previousPagestringrequired
Constraints:nullable
totalItemsnumber
Constraints:format: double
allstring
400· Invalid request. Please check the request input and try again.
statusintegerrequired
Allowed values:400
messagestringrequired
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired

Was this helpful?