---
canonical_url: "https://docs.composio.dev/toolkits/configcat"
markdown_url: "https://docs.composio.dev/toolkits/configcat.md"
product: "platform"
version: null
last_updated: null
---

# ConfigCat

ConfigCat is a feature flag management service for controlling feature rollouts, configurations, environments, and team access.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `CONFIGCAT`
- **Version:** 00000000_00

## Tools

### Create Flag or Setting

**Slug:** `CONFIGCAT_CREATE_SETTING`

Create a feature flag or typed setting in a Config. The key must be unique within that Config.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Unique SDK-facing key for the flag or setting (1-255 characters). |
| `hint` | string | No | Optional Dashboard description, up to 1000 characters. |
| `name` | string | Yes | Dashboard display name (1-255 characters). |
| `order` | integer | No | Optional ascending Dashboard display order. |
| `is_json` | boolean | No | For string settings, whether ConfigCat should validate served strings as JSON. |
| `tag_ids` | array | No | Optional existing tag IDs from CONFIGCAT_GET_PRODUCT_CONTEXT. |
| `config_id` | string | Yes | Config in which to create the flag or setting. |
| `setting_type` | string ("boolean" | "string" | "int" | "double") | Yes | Value type. 'boolean' creates a feature flag; 'string', 'int', and 'double' create typed settings. |
| `initial_values` | array | No | Optional initial values by environment. Each item contains environment_id and a value matching setting_type. Do not combine with setting_id_to_init_from. |
| `predefined_variations` | array | No | Optional reusable values whose JSON types must match setting_type. |
| `setting_id_to_init_from` | integer | No | Optional existing setting whose values and tags should initialize this setting. Do not combine with initial_values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Flag or Setting

**Slug:** `CONFIGCAT_DELETE_SETTING`

Permanently delete one ConfigCat feature flag or setting by ID. This cannot be undone; verify the setting ID before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `setting_id` | integer | Yes | Setting ID returned by CONFIGCAT_LIST_SETTINGS or CONFIGCAT_CREATE_SETTING. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Context

**Slug:** `CONFIGCAT_GET_PRODUCT_CONTEXT`

Return a ConfigCat Product's configs, environments, segments, and tags, including the identifiers and evaluation versions needed to manage flags and targeting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Product ID returned by CONFIGCAT_LIST_ACCOUNT_HIERARCHY. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Environment Setting Value V2

**Slug:** `CONFIGCAT_GET_SETTING_VALUE_V2`

Get one Config V2 flag or setting's complete evaluation formula in an Environment, including its optimistic-concurrency version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `setting_id` | integer | Yes | Setting ID from CONFIGCAT_LIST_SETTINGS. |
| `environment_id` | string | Yes | Environment ID from CONFIGCAT_GET_PRODUCT_CONTEXT. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Hierarchy

**Slug:** `CONFIGCAT_LIST_ACCOUNT_HIERARCHY`

List accessible ConfigCat organizations and products so an agent can resolve the IDs needed by product-scoped tools.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Environment Values V2

**Slug:** `CONFIGCAT_LIST_ENVIRONMENT_VALUES_V2`

Return every Config V2 feature flag and setting evaluation formula for one Config and Environment, preserving ordered targeting rules and concurrency versions while omitting parent objects and updater data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `config_id` | string | Yes | Config ID whose evaluation_version is v2. |
| `environment_id` | string | Yes | Environment ID in the same Product as the Config. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Flags and Settings

**Slug:** `CONFIGCAT_LIST_SETTINGS`

List feature flags and settings in one Config, including IDs, keys, types, tags, and metadata needed by value operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `config_id` | string | Yes | Config ID returned by CONFIGCAT_GET_PRODUCT_CONTEXT. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch Environment Setting Value V2

**Slug:** `CONFIGCAT_PATCH_SETTING_VALUE_V2`

Update selected typed fields of one Config V2 evaluation formula while preserving every field the caller omits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Audit-log reason. Required when the Product or Environment requires reasons. |
| `setting_id` | integer | Yes | Setting whose V2 evaluation formula should be patched. |
| `default_value` | object | No | New typed default value. Use exactly one of bool_value, string_value, int_value, double_value, or predefined_variation_id. Omit to preserve it. |
| `environment_id` | string | Yes | Environment containing the value to update. |
| `bypass_approval` | boolean | No | Bypass approval only when the connected user has that permission. Normally leave false. |
| `targeting_rules` | array | No | Complete ordered targeting-rule list. Pass [] to remove all rules; omit to preserve the current rules. |
| `latest_version_id` | string | Yes | Last version from CONFIGCAT_GET_SETTING_VALUE_V2. Required so a stale formula is rejected with 409 instead of overwriting concurrent changes. |
| `percentage_evaluation_attribute` | string | No | New user attribute for percentage evaluation. Omit to preserve it; use reset_percentage_evaluation_attribute to restore Identifier. |
| `reset_percentage_evaluation_attribute` | boolean | No | Set true to restore ConfigCat's Identifier attribute for percentage evaluation. Cannot be combined with percentage_evaluation_attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Environment Setting Value V2

**Slug:** `CONFIGCAT_REPLACE_SETTING_VALUE_V2`

Completely replace one Config V2 flag or setting evaluation formula in an Environment. Supply the complete default value, ordered targeting rules, and percentage attribute; omitted state is intentionally reset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Audit-log reason; required when the Product or Environment requires it. |
| `setting_id` | integer | Yes | Setting whose complete Config V2 formula should be replaced. |
| `default_value` | object | Yes | Complete typed default value. Use exactly one of bool_value, string_value, int_value, double_value, or predefined_variation_id. |
| `environment_id` | string | Yes | Environment containing the value to replace. |
| `bypass_approval` | boolean | No | Bypass approval only when authorized. Normally leave false. |
| `targeting_rules` | array | No | Complete ordered targeting-rule list. Pass [] to remove all rules. |
| `latest_version_id` | string | Yes | Last version from CONFIGCAT_GET_SETTING_VALUE_V2. Required so a stale formula is rejected with 409 instead of overwriting concurrent changes. |
| `percentage_evaluation_attribute` | string | No | Complete percentage bucketing attribute. Omit when use_identifier_for_percentage_evaluation is true. |
| `use_identifier_for_percentage_evaluation` | boolean | No | Set true to use ConfigCat's Identifier attribute for percentage evaluation. Exactly one of this flag or percentage_evaluation_attribute is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Flag Metadata

**Slug:** `CONFIGCAT_UPDATE_SETTING_METADATA`

Partially update a flag or setting's name, hint, or complete tag assignment without resetting untouched metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hint` | string | No | New hint text. Omit to leave unchanged; use clear_hint to remove it. |
| `name` | string | No | New non-empty display name. Omit to leave unchanged. |
| `tag_ids` | array | No | Complete desired tag-ID list. Pass [] to remove all tags; omit to leave tags unchanged. |
| `clear_hint` | boolean | No | Set true to remove the current hint; cannot be combined with hint. |
| `setting_id` | integer | Yes | Setting ID returned by CONFIGCAT_LIST_SETTINGS or CONFIGCAT_CREATE_SETTING. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |