Skip to main content
GET
/
console
/
v1
/
users
/
teams
List Teams
curl --request GET \
  --url https://statsigapi.net/console/v1/users/teams \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Teams listed successfully.",
  "data": [
    {
      "name": "test",
      "defaultGateMetrics": [],
      "defaultExperimentPrimaryMetrics": [],
      "defaultExperimentSecondaryMetrics": [],
      "defaultHoldoutMetrics": [],
      "changeTeamConfigs": "anyone",
      "reviewApproval": "anyone",
      "defaultTargetApplications": []
    },
    {
      "name": "Console Team",
      "defaultGateMetrics": [],
      "defaultExperimentPrimaryMetrics": [],
      "defaultExperimentSecondaryMetrics": [],
      "defaultHoldoutMetrics": [],
      "changeTeamConfigs": "anyone",
      "reviewApproval": "anyone",
      "defaultTargetApplications": []
    },
    {
      "name": "WHN-ish Team",
      "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"
  }
}

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

Get teams 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.