> 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

# The Flag object

> Reference for the Flag object, covering its attributes and the rules that target flags at companies and users.

The `Flag` object describes flags within your application. A new `Flag` is created in the Schematic application or via the API.

A `Flag` can target `Users` and `Companies` via rules. Rules can be based on objects, traits, or events.

### Attributes

**`id`** `string`

Unique `id` generated by Schematic for the object.

---

**`key`** `string`

The flag's unique `key`, which can be used to reference the flag.

---

**`name`** `string`

The flag's name, which is displayable to Schematic users.

---

**`description`** `string`

The flag's description, which is displayable to Schematic users.

---

**`flag_type`** `string`

The flag's type, which is currently limited to boolean.

---

**`default_value`** `boolean`

The flag's default value, which is served if no rules match.

---

**`created_at`** `datetime`

Datetime when the flag was created. Format is ISO 8601.

---

**`updated_at`** `datetime`

Datetime when the flag was updated. Format is ISO 8601.

---

**`feature_id`** `string`

Unique `id` of the feature the flag is associated with, if any.

---

**`feature`** `dictionary`

Set of features that the flag is associated with. Flags may only be associated with one feature.

---

**`latest_check`** `dictionary`

Result of the latest flag evaluation.

---

**`rules`** `dictionary`

Set of rules associated with the flag.

---

**`Response`**

```json Response
{
  "id": "flag_DVkYxxxJTZj",
  "key": "flag-key",
  "name": "New Flag",
  "description": "",
  "flag_type": "boolean",
  "default_value": false,
  "created_at": "2024-01-30T16:19:10.065408Z",
  "updated_at": "2024-01-30T16:19:10.065408Z",
  "feature_id": "feat_4W9xxx93pjj",
  "feature": {},
  "latest_check": {},
  "rules": {}
}
```

> Reference for the Flag object, covering its attributes and the rules that target flags at companies and users.