> ## Documentation Index
> Fetch the complete documentation index at: https://statsig-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# List Teams
## OpenAPI
````yaml api-reference/statsig_openapi.json get /console/v1/users/teams
openapi: 3.0.0
info:
title: Console API
description: >-
The "Console API" is the CRUD API for performing the actions offered on
console.statsig.com without needing to go through the web UI.
If you have any feature requests, drop on in to our [slack
channel](https://www.statsig.com/slack) and let us know.
Authorization
All requests must include the **STATSIG-API-KEY** field in the header. The
value should be a **Console API Key** which can be created in the Project
Settings on
[console.statsig.com/api_keys](https://console.statsig.com/api_keys)
Rate Limiting
Requests to the Console API are limited to ~ 100reqs / 10secs and ~
900reqs / 15 mins.
Keyboard Search
Use Ctrl/Cmd + K to search for specific endpoints.
version: 20240601.0.0
contact: {}
servers:
- url: https://statsigapi.net
security: []
tags: []
paths:
/console/v1/users/teams:
get:
tags:
- Users
summary: List Teams
parameters:
- name: limit
required: false
in: query
description: Results per page
schema:
example: 10
oneOf:
- type: string
- type: number
type: integer
- name: page
required: false
in: query
description: Page number
schema:
example: 1
oneOf:
- type: string
- type: number
type: integer
- name: x-respect-review-settings
in: header
description: Optional header to respect review settings for mutation endpoints.
required: false
schema:
type: string
responses:
'200':
description: Get teams response
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PaginationResponseWithMessage'
- properties:
data:
type: array
items:
$ref: '#/components/schemas/TeamDto'
example:
message: Teams listed successfully.
data:
- name: test
members:
- email: Test User@statsig.com
firstName: test
lastName: user
role: admin
- email: Test User@statsig.com
firstName: test
lastName: ''
role: admin
- email: Test User@statsig.com
firstName: test
lastName: ''
role: admin
admins: []
defaultGateMetrics: []
defaultExperimentPrimaryMetrics: []
defaultExperimentSecondaryMetrics: []
defaultHoldoutMetrics: []
changeTeamConfigs: anyone
reviewApproval: anyone
defaultTargetApplications: []
- name: Console Team
members:
- 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: admin
- 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: Test2
lastName: User2
role: admin
- email: test@statsig.com
firstName: test
lastName: ''
role: member
- email: test@statsig.com
firstName: test
lastName: ''
role: admin
- email: test@statsig.com
firstName: test
lastName: user
role: admin
- email: test@statsig.com
firstName: test
lastName: user
role: member
- email: test@statsig.com
firstName: test
lastName: user
role: member
- email: test@statsig.com
firstName: test
lastName: user
role: Owner
admins: []
defaultGateMetrics: []
defaultExperimentPrimaryMetrics: []
defaultExperimentSecondaryMetrics: []
defaultHoldoutMetrics: []
changeTeamConfigs: anyone
reviewApproval: anyone
defaultTargetApplications: []
- name: WHN-ish Team
members:
- email: d@statsig.com
firstName: d
lastName: user
role: admin
- email: test@statsig.com
firstName: test
lastName: test
role: admin
admins:
- email: test@statsig.com
firstName: test
lastName: test
role: admin
- email: test@statsig.com
firstName: test
lastName: test
role: admin
defaultGateMetrics:
- name: MA Custom Metric 2
type: event_user
- name: MA Custom Metric 9
type: event_count_custom
- name: MA Custom Metric 3
type: event_count_custom
defaultExperimentPrimaryMetrics: []
defaultExperimentSecondaryMetrics:
- name: MA Custom Metric 2
type: event_user
- name: MA Custom Metric 9
type: event_count_custom
- name: MA Custom Metric 3
type: event_count_custom
defaultHoldoutMetrics: []
changeTeamConfigs: team_only
reviewApproval: team_only
defaultTargetApplications: []
pagination:
itemsPerPage: 3
pageNumber: 1
totalItems: 8
nextPage: /console/v1/users/teams?page=2&limit=3
previousPage: null
all: /console/v1/users/teams
example:
message: Teams listed successfully.
data:
- name: test
members:
- email: Test User@statsig.com
firstName: test
lastName: user
role: admin
- email: Test User@statsig.com
firstName: test
lastName: ''
role: admin
- email: Test User@statsig.com
firstName: test
lastName: ''
role: admin
admins: []
defaultGateMetrics: []
defaultExperimentPrimaryMetrics: []
defaultExperimentSecondaryMetrics: []
defaultHoldoutMetrics: []
changeTeamConfigs: anyone
reviewApproval: anyone
defaultTargetApplications: []
- name: Console Team
members:
- 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: admin
- 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: Test2
lastName: User2
role: admin
- email: test@statsig.com
firstName: test
lastName: ''
role: member
- email: test@statsig.com
firstName: test
lastName: ''
role: admin
- email: test@statsig.com
firstName: test
lastName: user
role: admin
- email: test@statsig.com
firstName: test
lastName: user
role: member
- email: test@statsig.com
firstName: test
lastName: user
role: member
- email: test@statsig.com
firstName: test
lastName: user
role: Owner
admins: []
defaultGateMetrics: []
defaultExperimentPrimaryMetrics: []
defaultExperimentSecondaryMetrics: []
defaultHoldoutMetrics: []
changeTeamConfigs: anyone
reviewApproval: anyone
defaultTargetApplications: []
- name: WHN-ish Team
members:
- email: d@statsig.com
firstName: d
lastName: user
role: admin
- email: test@statsig.com
firstName: test
lastName: test
role: admin
admins:
- email: test@statsig.com
firstName: test
lastName: test
role: admin
- email: test@statsig.com
firstName: test
lastName: test
role: admin
defaultGateMetrics:
- name: MA Custom Metric 2
type: event_user
- name: MA Custom Metric 9
type: event_count_custom
- name: MA Custom Metric 3
type: event_count_custom
defaultExperimentPrimaryMetrics: []
defaultExperimentSecondaryMetrics:
- name: MA Custom Metric 2
type: event_user
- name: MA Custom Metric 9
type: event_count_custom
- name: MA Custom Metric 3
type: event_count_custom
defaultHoldoutMetrics: []
changeTeamConfigs: team_only
reviewApproval: team_only
defaultTargetApplications: []
pagination:
itemsPerPage: 3
pageNumber: 1
totalItems: 8
nextPage: /console/v1/users/teams?page=2&limit=3
previousPage: null
all: /console/v1/users/teams
'400':
description: Invalid request. Please check the request input and try again.
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 400
message:
type: string
required:
- status
- message
examples:
Invalid Request:
value:
status: 400
message: >-
Invalid request. Please check the request input and try
again.
'401':
description: >-
This endpoint only accepts an active CONSOLE key, but an invalid key
was sent. Key: console-xxxXXXxxxXXXxxx
content:
application/json:
schema:
type: object
properties:
status:
type: integer
enum:
- 401
message:
type: string
required:
- status
- message
examples:
Invalid Endpoint:
value:
status: 401
message: >-
This endpoint only accepts an active CONSOLE key, but an
invalid key was sent. Key: console-xxxXXXxxxXXXxxx
security:
- STATSIG-API-KEY: []
components:
schemas:
PaginationResponseWithMessage:
type: object
properties:
message:
type: string
description: A simple string explaining the result of the operation.
data:
description: Array of results returned by pagination limit.
type: array
items:
type: object
pagination:
description: Pagination metadata for checking if there is next page for example.
allOf:
- $ref: '#/components/schemas/PaginationResponseMetadataDto'
required:
- message
- data
- pagination
TeamDto:
type: object
properties:
name:
type: string
description: The name of the team.
description:
type: string
description: Description of the team.
id:
type: string
description: The ID of the team.
defaultGateMetrics:
type: array
items:
type: object
properties:
name:
type: string
description: The name of the metric.
type:
type: string
description: The type of the metric.
required:
- name
- type
description: Default gate metrics for the team.
defaultExperimentPrimaryMetrics:
type: array
items:
type: object
properties:
name:
type: string
description: The name of the metric.
type:
type: string
description: The type of the metric.
required:
- name
- type
description: Default primary metrics for experiments in the team.
defaultExperimentSecondaryMetrics:
type: array
items:
type: object
properties:
name:
type: string
description: The name of the metric.
type:
type: string
description: The type of the metric.
required:
- name
- type
description: Default secondary metrics for experiments in the team.
defaultHoldoutMetrics:
type: array
items:
type: object
properties:
name:
type: string
description: The name of the metric.
type:
type: string
description: The type of the metric.
required:
- name
- type
description: Default holdout metrics for the team.
changeTeamConfigs:
type: string
enum:
- anyone
- team_only
description: 'Who can change team configurations: "anyone" or "team_only".'
reviewApproval:
type: string
enum:
- anyone
- team_only
- admin_only
description: >-
Who can review and approve changes: "anyone", "team_only", or
"admin_only".
defaultTargetApplications:
type: array
items:
type: string
description: Default target applications for the team.
defaultHoldoutID:
type: string
nullable: true
description: Default holdout ID for the team, if applicable.
requireReviews:
type: boolean
nullable: true
description: Whether reviews are required for changes, if applicable.
requireGateTemplates:
type: boolean
nullable: true
description: Whether gate templates are required for the team, if applicable.
requireExperimentTemplates:
type: boolean
nullable: true
description: >-
Whether experiment templates are required for the team, if
applicable.
requireDynamicConfigTemplates:
type: boolean
nullable: true
description: >-
Whether dynamic config templates are required for the team, if
applicable.
members:
type: array
items:
type: object
properties:
email:
type: string
format: email
description: The email address of the user.
firstName:
type: string
description: The user's first name.
lastName:
type: string
description: The user's last name.
role:
type: string
description: >-
The user's role, which can be 'Admin', 'Read Only', 'Member',
or any custom role name.
required:
- email
- firstName
- lastName
- role
admins:
type: array
items:
type: object
properties:
email:
type: string
format: email
description: The email address of the user.
firstName:
type: string
description: The user's first name.
lastName:
type: string
description: The user's last name.
role:
type: string
description: >-
The user's role, which can be 'Admin', 'Read Only', 'Member',
or any custom role name.
required:
- email
- firstName
- lastName
- role
required:
- name
- id
- defaultGateMetrics
- defaultExperimentPrimaryMetrics
- defaultExperimentSecondaryMetrics
- defaultHoldoutMetrics
- changeTeamConfigs
- reviewApproval
- defaultTargetApplications
- members
- admins
PaginationResponseMetadataDto:
type: object
properties:
itemsPerPage:
type: number
pageNumber:
type: number
nextPage:
type: string
nullable: true
previousPage:
type: string
nullable: true
totalItems:
type: number
all:
type: string
required:
- itemsPerPage
- pageNumber
- nextPage
- previousPage
securitySchemes:
STATSIG-API-KEY:
type: apiKey
name: STATSIG-API-KEY
in: header
````