Skip to main content
GET
/
console
/
v1
/
roles
List Roles
curl --request GET \
  --url https://statsigapi.net/console/v1/roles \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Roles listed successfully.",
  "data": [
    {
      "name": "Custom Role",
      "permissions": {
        "invitation_access": false,
        "create_configs": false,
        "edit_or_delete_configs": false,
        "launch_to_production": false,
        "launch_or_disable_configs": false,
        "start_experiments": false,
        "create_or_edit_templates": false,
        "create_or_edit_dashboards": false,
        "create_teams": false,
        "edit_dynamic_config_schemas": false,
        "create_release_pipelines": false,
        "approve_required_review_release_pipeline_phase": false,
        "self_approve_review": false,
        "approve_reviews": false,
        "bypass_reviews_for_overrides": false,
        "metric_management": false,
        "verify_metrics": false,
        "use_metrics_explorer": false,
        "local_metrics": false,
        "manage_alerts": false,
        "integrations_edit_access": false,
        "source_connection_and_creation": false,
        "data_warehouse_ingestion_and_exports_edit_access": false,
        "edit_and_tag_configs_with_core_tag": false,
        "reset_experiments": false
      }
    }
  ],
  "pagination": {
    "itemsPerPage": 100,
    "pageNumber": 1,
    "totalItems": 1,
    "nextPage": null,
    "previousPage": null,
    "all": "/console/v1/roles"
  }
}

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 Roles 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.

I