Skip to main content
GET
/
console
/
v1
/
users
List Users
curl --request GET \
  --url https://statsigapi.net/console/v1/users \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "User listed successfully.",
  "data": [
    {
      "email": "test@statsig.com",
      "firstName": "a",
      "lastName": "b",
      "role": "admin"
    },
    {
      "email": "test@statsig.com",
      "firstName": "a",
      "lastName": "b",
      "role": "member"
    },
    {
      "email": "test@statsig.com",
      "firstName": "test",
      "lastName": "",
      "role": "admin"
    },
    {
      "email": "test@statsig.com",
      "firstName": "test",
      "lastName": "",
      "role": "member"
    },
    {
      "email": "test@statsig.com",
      "firstName": "test",
      "lastName": "user",
      "role": "member"
    },
    {
      "email": "test@statsig.com",
      "firstName": "test",
      "lastName": "user",
      "role": "admin"
    },
    {
      "email": "test@statsig.com",
      "firstName": "test",
      "lastName": "user",
      "role": "admin"
    },
    {
      "email": "test@statsig.com",
      "firstName": "test",
      "lastName": "user",
      "role": "member"
    }
  ],
  "pagination": {
    "itemsPerPage": 10,
    "pageNumber": 4,
    "totalItems": 38,
    "nextPage": null,
    "previousPage": "/console/v1/users?page=3&limit=10",
    "all": "/console/v1/users"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

Response

List users response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object[]
required

Array of results returned by pagination limit.

​
pagination
object
required

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