---
title: Audit Overrides
description: "Returns overrides across all gates, holdouts, experiments, autotunes, and layers in the project. Provide userId (optionally with idType ) to audit everywhere…"
product: general
token_estimate: 3096
---
# Audit Overrides

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

## Audit Overrides

**GET** `/console/v1/overrides`

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

Audit Overrides

Returns overrides across all gates, holdouts, experiments, autotunes, and layers in the project. Provide `userId` (optionally with `idType`) to audit everywhere a single unit ID is overridden; omit it to export every override. Each section only lists entities that have matching overrides.

## Authorizations

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

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| userId (query) | string | No | user-123 | Unit ID to audit. When provided, the response only includes entities that override this ID, narrowed to the matching ID. When omitted, every override across all entities is returned. |
| idType (query) | string | No | userID | The unit ID type that `userId` refers to (e.g. 'userID', 'stableID', or a custom unit ID type). Accepts snake_case or camelCase. Defaults to 'userID'. Ignored when `userId` is omitted. |

## Response (application/json)

**200** — Audit Overrides Success

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| message | string | Yes | — | A simple string explaining the result of the operation. |
| data | object | Yes | — | Overrides grouped by entity type. Each section only lists entities that have (matching) overrides. |
| data.gates | object[] | Yes | — | Feature gates with matching overrides. |
| data.gates.id | string | Yes | my_gate | Entity identifier (name) |
| data.gates.name | string | Yes | My Gate | Entity display name |
| data.gates.passingUserIDs | string[] | Yes | ["user123","user456","user789"] | List of user IDs |
| data.gates.failingUserIDs | string[] | Yes | ["user123","user456","user789"] | List of user IDs |
| data.gates.passingCustomIDs | string[] | No | ["custom123","custom456"] | Optional list of custom IDs |
| data.gates.failingCustomIDs | string[] | No | ["custom123","custom456"] | Optional list of custom IDs |
| data.gates.environmentOverrides | object[] | Yes | — | — |
| data.gates.environmentOverrides.environment | string | No | staging | Environment Constraints: nullable |
| data.gates.environmentOverrides.unitID | string | Yes | unit123 | Unit ID Constraints: nullable |
| data.gates.environmentOverrides.passingIDs | string[] | Yes | ["id1","id2"] | List of passing IDs |
| data.gates.environmentOverrides.failingIDs | string[] | Yes | ["id3","id4"] | List of failing IDs |
| data.holdouts | object[] | Yes | — | Holdouts with matching overrides. |
| data.holdouts.id | string | Yes | my_gate | Entity identifier (name) |
| data.holdouts.name | string | Yes | My Gate | Entity display name |
| data.holdouts.passingUserIDs | string[] | Yes | ["user123","user456","user789"] | List of user IDs |
| data.holdouts.failingUserIDs | string[] | Yes | ["user123","user456","user789"] | List of user IDs |
| data.holdouts.passingCustomIDs | string[] | No | ["custom123","custom456"] | Optional list of custom IDs |
| data.holdouts.failingCustomIDs | string[] | No | ["custom123","custom456"] | Optional list of custom IDs |
| data.holdouts.environmentOverrides | object[] | Yes | — | — |
| data.holdouts.environmentOverrides.environment | string | No | staging | Environment Constraints: nullable |
| data.holdouts.environmentOverrides.unitID | string | Yes | unit123 | Unit ID Constraints: nullable |
| data.holdouts.environmentOverrides.passingIDs | string[] | Yes | ["id1","id2"] | List of passing IDs |
| data.holdouts.environmentOverrides.failingIDs | string[] | Yes | ["id3","id4"] | List of failing IDs |
| data.experiments | object[] | Yes | — | Experiments with matching overrides. |
| data.experiments.id | string | Yes | my_gate | Entity identifier (name) |
| data.experiments.name | string | Yes | My Gate | Entity display name |
| data.experiments.overrides | object[] | Yes | — | Array of experiment overrides, each specifying type, ID, and group ID. |
| data.experiments.overrides.type | string | Yes | — | Allowed values: gate, segment |
| data.experiments.overrides.id | string | Yes | — | The id of the segment or gate |
| data.experiments.overrides.groupID | string | Yes | — | The experiment group which user will be forced into |
| data.experiments.overrides.environment | string | No | — | Optional environment designation (e.g., production, staging) for the experiment. Constraints: nullable |
| data.experiments.userIDOverrides | object[] | Yes | — | Array of user ID overrides, specifying which users to force into experiment groups. |
| data.experiments.userIDOverrides.groupID | string | Yes | — | The experiment group the user will be forced into. |
| data.experiments.userIDOverrides.ids | string[] | Yes | — | Array of user IDs to be assigned to the specified experiment group. |
| data.experiments.userIDOverrides.environment | string | No | — | Optional environment designation (e.g., production, staging) for the experiment. Constraints: nullable |
| data.experiments.userIDOverrides.unitType | string | No | — | Optional type of unit for the experiment, defining the scope of the override. Constraints: nullable |
| data.autotunes | object[] | Yes | — | Autotunes with matching overrides. |
| data.autotunes.id | string | Yes | my_gate | Entity identifier (name) |
| data.autotunes.name | string | Yes | My Gate | Entity display name |
| data.autotunes.overrides | object[] | Yes | — | Array of experiment overrides, each specifying type, ID, and group ID. |
| data.autotunes.overrides.type | string | Yes | — | Allowed values: gate, segment |
| data.autotunes.overrides.id | string | Yes | — | The id of the segment or gate |
| data.autotunes.overrides.groupID | string | Yes | — | The experiment group which user will be forced into |
| data.autotunes.overrides.environment | string | No | — | Optional environment designation (e.g., production, staging) for the experiment. Constraints: nullable |
| data.autotunes.userIDOverrides | object[] | Yes | — | Array of user ID overrides, specifying which users to force into experiment groups. |
| data.autotunes.userIDOverrides.groupID | string | Yes | — | The experiment group the user will be forced into. |
| data.autotunes.userIDOverrides.ids | string[] | Yes | — | Array of user IDs to be assigned to the specified experiment group. |
| data.autotunes.userIDOverrides.environment | string | No | — | Optional environment designation (e.g., production, staging) for the experiment. Constraints: nullable |
| data.autotunes.userIDOverrides.unitType | string | No | — | Optional type of unit for the experiment, defining the scope of the override. Constraints: nullable |
| data.layers | object[] | Yes | — | Layers with matching overrides. |
| data.layers.id | string | Yes | my_gate | Entity identifier (name) |
| data.layers.name | string | Yes | My Gate | Entity display name |
| data.layers.conditionalOverrides | object[] | Yes | — | — |
| data.layers.conditionalOverrides.type | string | Yes | — | Describes whether layer override is segment or gate |
| data.layers.conditionalOverrides.name | string | Yes | — | Name of override entity |
| data.layers.conditionalOverrides.experimentName | string | Yes | — | — |
| data.layers.conditionalOverrides.groupName | string | Yes | — | — |
| data.layers.conditionalOverrides.environment | string | No | — | Optional environment scope (e.g. production, staging). Omit or pass null to target the all-environments bucket. Constraints: nullable |
| data.layers.idOverrides | object[] | Yes | — | — |
| data.layers.idOverrides.groupName | string | Yes | — | Group that ID is overriden into |
| data.layers.idOverrides.ids | string[] | Yes | — | ID being overriden into a particular group |
| data.layers.idOverrides.idType | string | No | — | Constraints: nullable |
| data.layers.idOverrides.environment | string | No | — | Constraints: nullable |
| data.layers.idOverrides.experimentName | string | No | — | Constraints: nullable |

```json
{
  "message": "Overrides read successfully.",
  "data": {
    "gates": [
      {
        "id": "my_gate",
        "name": "My Gate",
        "passingUserIDs": [
          "user-123"
        ],
        "failingUserIDs": [],
        "environmentOverrides": [
          {
            "environment": null,
            "unitID": "userID",
            "passingIDs": [
              "user-123"
            ],
            "failingIDs": []
          }
        ]
      }
    ],
    "holdouts": [],
    "experiments": [
      {
        "id": "my_experiment",
        "name": "My Experiment",
        "overrides": [],
        "userIDOverrides": [
          {
            "groupID": "Control",
            "ids": [
              "user-123"
            ],
            "environment": null,
            "unitType": "userID"
          }
        ]
      }
    ],
    "autotunes": [],
    "layers": []
  }
}
```

**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/overrides?userId=user-123&idType=userID" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://statsigapi.net/console/v1/overrides?userId=user-123&idType=userID",
    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/overrides?userId=user-123&idType=userID", {
  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/overrides?userId=user-123&idType=userID");
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/overrides?userId=user-123&idType=userID", 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/overrides?userId=user-123&idType=userID"))
      .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/overrides?userId=user-123&idType=userID")
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
```