Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Statsig Console Users API
description: The Statsig Console API enables developers to programmatically manage their Statsig project configuration.
version: '20240601'
contact:
name: Statsig Support
url: https://statsig.com/support
termsOfService: https://statsig.com/terms
servers:
- url: https://statsigapi.net/console/v1
description: Statsig Console API Server
security:
- consoleApiKey: []
tags:
- name: Users
description: Manage user data and lookup user properties within the Statsig project.
paths:
/users:
get:
operationId: listUsers
summary: List users
description: Retrieves a list of users known to the Statsig project.
tags:
- Users
parameters:
- $ref: '#/components/parameters/ApiVersion'
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Page'
responses:
'200':
description: List of users
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/User'
pagination:
$ref: '#/components/schemas/Pagination'
'401':
$ref: '#/components/responses/Unauthorized'
components:
parameters:
Limit:
name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 100
description: Maximum number of items to return per page.
ApiVersion:
name: STATSIG-API-VERSION
in: header
required: false
schema:
type: string
default: '20240601'
description: The Console API version. Currently the only version is 20240601.
Page:
name: page
in: query
required: false
schema:
type: integer
minimum: 1
description: Page number for paginated results.
schemas:
Pagination:
type: object
description: Pagination metadata for list responses.
properties:
total:
type: integer
description: Total number of items available.
page:
type: integer
description: Current page number.
limit:
type: integer
description: Number of items per page.
hasMore:
type: boolean
description: Whether more pages are available.
User:
type: object
description: A user record in the Statsig project.
properties:
userID:
type: string
description: The unique identifier of the user.
email:
type: string
format: email
description: The user email address.
properties:
type: object
description: Custom properties associated with the user.
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error message describing the authentication failure.
securitySchemes:
consoleApiKey:
type: apiKey
in: header
name: STATSIG-API-KEY
description: Console API Key created in Project Settings > API Keys tab. Required for all Console API requests.
externalDocs:
description: Statsig Console API Documentation
url: https://docs.statsig.com/console-api/