---
title: List Roles
description: Reference for the GET /console/v1/roles API endpoint.
product: general
token_estimate: 2025
---
# List Roles

> For AI agents: a documentation index is available at [/llms.txt](/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## List Roles

**GET** `/console/v1/roles`

Full URL: `https://statsigapi.net/console/v1/roles`

List Roles

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| STATSIG-API-KEY | string | Yes | — | apiKey (header) |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| limit (query) | integer | No | 10 | Results per page Constraints: string, number |
| page (query) | integer | No | 1 | Page number Constraints: string, number |

## Response (application/json)

**200** — List Roles Response

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| message | string | Yes | — | A simple string explaining the result of the operation. |
| data | object[] | Yes | — | — |
| data.name | string | Yes | — | The name of the role. |
| data.permissions | object | Yes | — | The permissions of the role. |
| data.permissions.invitation_access | boolean | No | — | — |
| data.permissions.create_configs | boolean | No | — | — |
| data.permissions.edit_or_delete_configs | boolean | No | — | — |
| data.permissions.delete_configs | boolean | No | — | — |
| data.permissions.launch_to_production | boolean | No | — | — |
| data.permissions.launch_or_disable_configs | boolean | No | — | — |
| data.permissions.start_experiments | boolean | No | — | — |
| data.permissions.create_or_edit_templates | boolean | No | — | — |
| data.permissions.create_or_edit_dashboards | boolean | No | — | — |
| data.permissions.create_teams | boolean | No | — | — |
| data.permissions.edit_dynamic_config_schemas | boolean | No | — | — |
| data.permissions.create_release_pipelines | boolean | No | — | — |
| data.permissions.approve_required_review_release_pipeline_phase | boolean | No | — | — |
| data.permissions.self_approve_review | boolean | No | — | — |
| data.permissions.approve_reviews | boolean | No | — | — |
| data.permissions.bypass_reviews_for_overrides | boolean | No | — | — |
| data.permissions.bypass_precommit_webhook | boolean | No | — | — |
| data.permissions.metric_management | boolean | No | — | — |
| data.permissions.event_dimensions_access | boolean | No | — | — |
| data.permissions.verify_metrics | boolean | No | — | — |
| data.permissions.use_metrics_explorer | boolean | No | — | — |
| data.permissions.local_metrics | boolean | No | — | — |
| data.permissions.manage_alerts | boolean | No | — | — |
| data.permissions.integrations_edit_access | boolean | No | — | — |
| data.permissions.source_connection_and_creation | boolean | No | — | — |
| data.permissions.whn_connection | boolean | No | — | — |
| data.permissions.data_warehouse_ingestion_and_exports_edit_access | boolean | No | — | — |
| data.permissions.edit_and_tag_configs_with_core_tag | boolean | No | — | — |
| data.permissions.reset_experiments | boolean | No | — | — |
| data.permissions.manual_whn_reload | boolean | No | — | — |
| pagination | object | Yes | — | Pagination metadata for checking if there is next page for example. |
| pagination.itemsPerPage | number | Yes | — | Constraints: format: double |
| pagination.pageNumber | number | Yes | — | Constraints: format: double |
| pagination.nextPage | string | Yes | — | Constraints: nullable |
| pagination.previousPage | string | Yes | — | Constraints: nullable |
| pagination.totalItems | number | No | — | Constraints: format: double |
| pagination.all | string | No | — | — |

```json
{
  "message": "Roles listed successfully.",
  "data": [
    {
      "name": "Custom Role",
      "permissions": {
        "invitation_access": false,
        "create_configs": false,
        "edit_or_delete_configs": false,
        "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"
  }
}
```

**400** — Invalid request. Please check the request input and try again.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| status | integer | Yes | — | Allowed values: 400 |
| message | string | Yes | — | — |

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

**401** — This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| status | integer | Yes | — | Allowed values: 401 |
| message | string | Yes | — | — |

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

## Code samples

### cURL

```bash
curl -X GET "https://statsigapi.net/console/v1/roles?limit=10&page=1" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://statsigapi.net/console/v1/roles?limit=10&page=1",
    headers={
        "Content-Type": "application/json",
        "STATSIG-API-KEY": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://statsigapi.net/console/v1/roles?limit=10&page=1", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "STATSIG-API-KEY": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://statsigapi.net/console/v1/roles?limit=10&page=1");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "STATSIG-API-KEY: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("GET", "https://statsigapi.net/console/v1/roles?limit=10&page=1", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("STATSIG-API-KEY", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://statsigapi.net/console/v1/roles?limit=10&page=1"))
      .method("GET", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("STATSIG-API-KEY", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://statsigapi.net/console/v1/roles?limit=10&page=1")
request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["STATSIG-API-KEY"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```