> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# List flags

GET https://api.schematichq.com/flags

Reference: https://docs.schematichq.com/api-reference/features/list-flags

## Authentication

- `X-Schematic-Api-Key` header (required) — API Key authentication via header

## Request

### Query parameters

- `feature_id` (string, optional)
- `ids` (list of string, optional)
- `q` (string, optional) — Search by flag name, key, or ID
- `limit` (long, optional) — Page limit (default 100)
- `offset` (long, optional) — Page offset (default 0)

## Response

### 200

OK

- `data` (list of FlagDetailResponseData, required)
- `params` (FlagsGetResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 400 Bad Request Error

Bad request

- `error` (string, required) — Error message

### 401 Unauthorized Error

Unauthorized

- `error` (string, required) — Error message

### 403 Forbidden Error

Forbidden

- `error` (string, required) — Error message

### 404 Not Found Error

Not found

- `error` (string, required) — Error message

### 500 Internal Server Error

Server error

- `error` (string, required) — Error message

## Types

### FlagDetailResponseData

- `created_at` (datetime, required)
- `default_value` (boolean, required)
- `description` (string, required)
- `flag_type` (enum, required)
  - Allowed values: `boolean`
- `id` (string, required)
- `key` (string, required)
- `name` (string, required)
- `rules` (list of RuleDetailResponseData, required)
- `updated_at` (datetime, required)
- `feature` (FeatureResponseData, optional)
- `feature_id` (string, optional, nullable)
- `last_checked_at` (datetime, optional, nullable)
- `maintainer` (AccountMemberResponseData, optional)
- `maintainer_account_member_id` (string, optional, nullable)

### FlagsGetResponsesContentApplicationJsonSchemaParams

Input parameters

- `feature_id` (string, optional)
- `ids` (list of string, optional)
- `limit` (long, optional) — Page limit (default 100)
- `offset` (long, optional) — Page offset (default 0)
- `q` (string, optional) — Search by flag name, key, or ID

### RuleDetailResponseData

- `condition_groups` (list of RuleConditionGroupDetailResponseData, required)
- `conditions` (list of RuleConditionDetailResponseData, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `name` (string, required)
- `priority` (long, required)
- `rule_type` (enum, required)
  - Allowed values: `company_override`, `company_override_usage_exceeded`, `default`, `global_override`, `plan_entitlement`, `plan_entitlement_usage_exceeded`, `standard`
- `updated_at` (datetime, required)
- `value` (boolean, required)
- `flag_id` (string, optional, nullable)

### FeatureResponseData

- `created_at` (datetime, required)
- `description` (string, required)
- `feature_type` (enum, required)
  - Allowed values: `boolean`, `event`, `license`, `trait`
- `icon` (string, required)
- `id` (string, required)
- `name` (string, required)
- `updated_at` (datetime, required)
- `event_subtype` (string, optional, nullable)
- `license_id` (string, optional, nullable) — The license sold through this feature. Set only on features of type license, and created automatically with them.
- `lifecycle_phase` (enum, optional, nullable)
  - Allowed values: `add_on`, `alpha`, `beta`, `deprecated`, `ga`, `inactive`, `in_plan`, `internal_testing`, `legacy`
- `maintainer_account_member_id` (string, optional, nullable)
- `plural_name` (string, optional, nullable)
- `singular_name` (string, optional, nullable)
- `trait_id` (string, optional, nullable)
- `usage_limit_trait_id` (string, optional, nullable) — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.

### AccountMemberResponseData

- `created_at` (datetime, required)
- `id` (string, required)
- `permissions` (map from string to list of enum, required)
  - Allowed values: `companies_edit`, `company_users_edit`, `components_edit`, `custom_plans_edit`, `data_exports_edit`, `features_edit`, `flag_rules_edit`, `flags_edit`, `overrides_edit`, `plan_billing_edit`, `plan_entitlements_edit`, `plan_versions_edit`, `plans_edit`, `webhooks_edit`, `webhooks_reveal_secret`
- `updated_at` (datetime, required)
- `email` (string, optional, nullable)
- `first_name` (string, optional, nullable)
- `image_url` (string, optional, nullable)
- `last_name` (string, optional, nullable)
- `name` (string, optional, nullable)
- `role` (enum, optional, nullable)
  - Allowed values: `admin`, `member`

### RuleConditionGroupDetailResponseData

- `conditions` (list of RuleConditionDetailResponseData, required)
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `rule_id` (string, required)
- `updated_at` (datetime, required)
- `flag_id` (string, optional, nullable)

### RuleConditionDetailResponseData

- `condition_type` (enum, required)
  - Allowed values: `base_plan`, `billing_product`, `company`, `credit`, `metric`, `plan`, `plan_version`, `trait`, `user`
- `created_at` (datetime, required)
- `environment_id` (string, required)
- `id` (string, required)
- `operator` (enum, required)
  - Allowed values: `eq`, `gt`, `gte`, `is_empty`, `lt`, `lte`, `not_empty`, `ne`
- `resource_ids` (list of string, required)
- `resources` (list of PreviewObjectResponseData, required)
- `rule_id` (string, required)
- `trait_value` (string, required)
- `updated_at` (datetime, required)
- `comparison_trait` (EntityTraitDefinitionResponseData, optional)
- `comparison_trait_id` (string, optional, nullable)
- `condition_group_id` (string, optional, nullable)
- `event_subtype` (string, optional, nullable)
- `flag_id` (string, optional, nullable)
- `metric_period` (enum, optional, nullable)
  - Allowed values: `all_time`, `current_day`, `current_month`, `current_week`
- `metric_period_month_reset` (enum, optional, nullable)
  - Allowed values: `billing_cycle`, `first_of_month`
- `metric_value` (long, optional, nullable)
- `plan_versions` (list of RuleConditionPlanVersionResponseData, optional)
- `trait` (EntityTraitDefinitionResponseData, optional)
- `trait_entity_type` (enum, optional, nullable)
  - Allowed values: `company`, `user`
- `trait_id` (string, optional, nullable)

### PreviewObjectResponseData

- `id` (string, required)
- `name` (string, required)
- `description` (string, optional, nullable)
- `image_url` (string, optional, nullable)

### EntityTraitDefinitionResponseData

- `created_at` (datetime, required)
- `display_name` (string, required)
- `entity_type` (enum, required)
  - Allowed values: `company`, `user`
- `hierarchy` (list of string, required)
- `id` (string, required)
- `trait_type` (enum, required)
  - Allowed values: `boolean`, `currency`, `date`, `number`, `string`, `url`
- `updated_at` (datetime, required)

### RuleConditionPlanVersionResponseData

- `id` (string, required)
- `name` (string, required)
- `status` (enum, required)
  - Allowed values: `published`, `draft`, `archived`
- `version` (long, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "default_value": true,
      "description": "string",
      "flag_type": "boolean",
      "id": "string",
      "key": "string",
      "name": "string",
      "rules": [
        {
          "condition_groups": [
            {
              "conditions": [
                {
                  "condition_type": "base_plan",
                  "created_at": "2024-01-15T09:30:00Z",
                  "environment_id": "string",
                  "id": "string",
                  "operator": "eq",
                  "resource_ids": [
                    "string"
                  ],
                  "resources": [
                    {
                      "id": "string",
                      "name": "string",
                      "description": "string",
                      "image_url": "string"
                    }
                  ],
                  "rule_id": "string",
                  "trait_value": "string",
                  "updated_at": "2024-01-15T09:30:00Z",
                  "comparison_trait": {
                    "created_at": "2024-01-15T09:30:00Z",
                    "display_name": "string",
                    "entity_type": "company",
                    "hierarchy": [
                      "string"
                    ],
                    "id": "string",
                    "trait_type": "boolean",
                    "updated_at": "2024-01-15T09:30:00Z"
                  },
                  "comparison_trait_id": "string",
                  "condition_group_id": "string",
                  "event_subtype": "string",
                  "flag_id": "string",
                  "metric_period": "all_time",
                  "metric_period_month_reset": "billing_cycle",
                  "metric_value": 1,
                  "plan_versions": [
                    {
                      "id": "string",
                      "name": "string",
                      "status": "published",
                      "version": 1
                    }
                  ],
                  "trait": {
                    "created_at": "2024-01-15T09:30:00Z",
                    "display_name": "string",
                    "entity_type": "company",
                    "hierarchy": [
                      "string"
                    ],
                    "id": "string",
                    "trait_type": "boolean",
                    "updated_at": "2024-01-15T09:30:00Z"
                  },
                  "trait_entity_type": "company",
                  "trait_id": "string"
                }
              ],
              "created_at": "2024-01-15T09:30:00Z",
              "environment_id": "string",
              "id": "string",
              "rule_id": "string",
              "updated_at": "2024-01-15T09:30:00Z",
              "flag_id": "string"
            }
          ],
          "conditions": [
            {
              "condition_type": "base_plan",
              "created_at": "2024-01-15T09:30:00Z",
              "environment_id": "string",
              "id": "string",
              "operator": "eq",
              "resource_ids": [
                "string"
              ],
              "resources": [
                {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "image_url": "string"
                }
              ],
              "rule_id": "string",
              "trait_value": "string",
              "updated_at": "2024-01-15T09:30:00Z",
              "comparison_trait": {
                "created_at": "2024-01-15T09:30:00Z",
                "display_name": "string",
                "entity_type": "company",
                "hierarchy": [
                  "string"
                ],
                "id": "string",
                "trait_type": "boolean",
                "updated_at": "2024-01-15T09:30:00Z"
              },
              "comparison_trait_id": "string",
              "condition_group_id": "string",
              "event_subtype": "string",
              "flag_id": "string",
              "metric_period": "all_time",
              "metric_period_month_reset": "billing_cycle",
              "metric_value": 1,
              "plan_versions": [
                {
                  "id": "string",
                  "name": "string",
                  "status": "published",
                  "version": 1
                }
              ],
              "trait": {
                "created_at": "2024-01-15T09:30:00Z",
                "display_name": "string",
                "entity_type": "company",
                "hierarchy": [
                  "string"
                ],
                "id": "string",
                "trait_type": "boolean",
                "updated_at": "2024-01-15T09:30:00Z"
              },
              "trait_entity_type": "company",
              "trait_id": "string"
            }
          ],
          "created_at": "2024-01-15T09:30:00Z",
          "environment_id": "string",
          "id": "string",
          "name": "string",
          "priority": 1,
          "rule_type": "company_override",
          "updated_at": "2024-01-15T09:30:00Z",
          "value": true,
          "flag_id": "string"
        }
      ],
      "updated_at": "2024-01-15T09:30:00Z",
      "feature": {
        "created_at": "2024-01-15T09:30:00Z",
        "description": "string",
        "feature_type": "boolean",
        "icon": "string",
        "id": "string",
        "name": "string",
        "updated_at": "2024-01-15T09:30:00Z",
        "event_subtype": "string",
        "license_id": "string",
        "lifecycle_phase": "add_on",
        "maintainer_account_member_id": "string",
        "plural_name": "string",
        "singular_name": "string",
        "trait_id": "string",
        "usage_limit_trait_id": "string"
      },
      "feature_id": "string",
      "last_checked_at": "2024-01-15T09:30:00Z",
      "maintainer": {
        "created_at": "2024-01-15T09:30:00Z",
        "id": "string",
        "permissions": {},
        "updated_at": "2024-01-15T09:30:00Z",
        "email": "string",
        "first_name": "string",
        "image_url": "string",
        "last_name": "string",
        "name": "string",
        "role": "admin"
      },
      "maintainer_account_member_id": "string"
    }
  ],
  "params": {
    "feature_id": "string",
    "ids": [
      "string"
    ],
    "limit": 100,
    "offset": 0,
    "q": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/flags"

headers = {"X-Schematic-Api-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/flags';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.schematichq.com/flags"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.schematichq.com/flags")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.schematichq.com/flags")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.schematichq.com/flags', [
  'headers' => [
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/flags");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Schematic-Api-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/flags")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```