List Users

curl --request GET \
  --url https://statsigapi.net/console/v1/users \
  --header 'STATSIG-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'STATSIG-API-KEY': '<api-key>'}};

fetch('https://statsigapi.net/console/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://statsigapi.net/console/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://statsigapi.net/console/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("STATSIG-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["STATSIG-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "status": 400,
  "message": "Invalid request. Please check the request input and try again."
}

{
  "status": 401,
  "message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}

GET

console

users

List Users

curl --request GET \
  --url https://statsigapi.net/console/v1/users \
  --header 'STATSIG-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'STATSIG-API-KEY': '<api-key>'}};

fetch('https://statsigapi.net/console/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://statsigapi.net/console/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://statsigapi.net/console/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("STATSIG-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["STATSIG-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

{
  "status": 400,
  "message": "Invalid request. Please check the request input and try again."
}

{
  "status": 401,
  "message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}

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.

Show child attributes

pagination

object

required

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

Show child attributes

⌘I

HTTP API

Console API

Alerts

Audit Logs

Autotunes

Company

Dynamic Configs

Events

Experiments

Experiments (Warehouse Native)

Configs

Gates

Holdouts

Ingestions

Keys

Layers

Metrics

Metrics (Warehouse Native)

Project

Usage

Reports

Segments

Tags

Target App

Users

List Users

Authorizations

Headers

Query Parameters

Response