For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
Getting StartedAPI ReferenceRoadmapBlog
Getting StartedAPI ReferenceRoadmapBlog
    • Resources
    • Authentication
    • Pagination
    • Rate limiting
  • API Keys
    • GETList api keys
    • GETGet api key
    • POSTCreate api key
    • PUTUpdate api key
    • DELDelete api key
  • Environments
    • POSTCreate environment
    • PUTUpdate environment
    • DELDelete environment
  • Plans
    • The Plan object
    • GETList plans
    • GETGet plan
    • POSTCreate plan
    • PUTUpdate plan
    • DELDelete plan
  • Companies
    • The Company object
    • GETList companies
    • POSTUpsert company
    • GETLookup company
    • DELDelete company
    • POSTDelete company by keys
    • GETList company memberships
    • POSTGet or create company membership
    • DELDelete company membership
    • POSTUpsert company trait
  • Users
    • The User object
    • GETList users
    • GETLookup user
    • POSTUpsert user
    • DELDelete user
    • POSTDelete user by keys
    • POSTUpsert user trait
  • Events
    • The Event object
    • GETList events
    • POSTCreate event
    • POSTCreate event batch
    • GETGet event
  • Features
    • The Feature object
    • GETList features
    • GETGet feature
    • POSTCreate feature
    • PUTUpdate feature
    • DELDelete feature
  • Flags
    • The Flag object
    • GETList flags
    • GETGet flag
    • POSTCreate flag
    • PUTUpdate flag
    • DELDelete flag
    • PUTUpdate flag rules
    • POSTCheck flag
    • POSTCheck flags
  • Entitlements
    • GETList company overrides
    • GETGet company override
    • POSTCreate company override
    • PUTUpdate company override
    • DELDelete company override
    • GETList plan entitlements
    • GETGet plan entitlement
    • POSTCreate plan entitlement
    • PUTUpdate plan entitlement
    • DELDelete plan entitlement
  • Feature Usage
    • GETList feature usage
  • Billing Credits
    • GETList credits
    • POSTCreate credit
    • GETGet credit
    • PUTUpdate credit
    • DELDelete credit
    • GETList credit bundles
    • POSTCreate credit bundle
    • GETGet credit bundle
    • PUTUpdate credit bundle
    • DELDelete credit bundle
    • POSTGrant credits to company
    • GETList company credit grants
    • GETList credit grants
    • PUTZero out credit grant
    • GETList plan credit grants
    • POSTCreate plan credit grant
    • DELDelete plan credit grant
    • GETGet credit ledger
  • Account Members
    • GETList account members
    • GETGet account member
LogoLogo
SupportDashboard
Flags

Get flag

GET
https://api.schematichq.com/flags/:flag_id
GET
/flags/:flag_id
1import { SchematicClient } from "@schematichq/schematic-typescript-node";
2
3async function main() {
4    const client = new SchematicClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.features.getFlag("flag_id");
8}
9main();
1{
2  "data": {
3    "created_at": "2024-01-15T09:30:00Z",
4    "default_value": true,
5    "description": "Enable dark mode feature flag for beta users",
6    "flag_type": "boolean",
7    "id": "flag-1234abcd-5678-ef90-1234-56789abcdef0",
8    "key": "dark_mode_enabled",
9    "name": "Dark Mode Flag",
10    "rules": [
11      {
12        "condition_groups": [
13          {
14            "conditions": [
15              {
16                "condition_type": "plan",
17                "created_at": "2024-01-15T09:30:00Z",
18                "environment_id": "env-prod-001",
19                "id": "cond-1111aaaa-2222-bbbb-3333-cccc4444dddd",
20                "operator": "eq",
21                "resource_ids": [
22                  "res-5555eeee-6666-ffff-7777-gggg8888hhhh"
23                ],
24                "resources": [
25                  {
26                    "id": "res-5555eeee-6666-ffff-7777-gggg8888hhhh",
27                    "name": "Enterprise",
28                    "description": "Enterprise Plan",
29                    "image_url": "https://example.com/images/enterprise_plan.png"
30                  }
31                ],
32                "rule_id": "rule-9999aaaa-8888-bbbb-7777-cccc6666dddd",
33                "trait_value": "enterprise",
34                "updated_at": "2024-01-15T09:30:00Z",
35                "comparison_trait": {
36                  "created_at": "2023-10-10T07:00:00Z",
37                  "display_name": "Subscription Plan",
38                  "entity_type": "company",
39                  "hierarchy": [
40                    "enterprise",
41                    "premium"
42                  ],
43                  "id": "trait-9876abcd-1234-ef56-7890-abcdef123456",
44                  "trait_type": "string",
45                  "updated_at": "2024-01-05T11:00:00Z"
46                },
47                "comparison_trait_id": "trait-9876abcd-1234-ef56-7890-abcdef123456",
48                "condition_group_id": "cg-1234abcd-5678-ef90-1234-56789abcdef0",
49                "event_subtype": null,
50                "flag_id": "flag-1234abcd-5678-ef90-1234-56789abcdef0",
51                "metric_period": "all_time",
52                "metric_period_month_reset": "billing_cycle",
53                "metric_value": 0,
54                "trait": {
55                  "created_at": "2023-10-10T07:00:00Z",
56                  "display_name": "Subscription Plan",
57                  "entity_type": "company",
58                  "hierarchy": [
59                    "enterprise",
60                    "premium"
61                  ],
62                  "id": "trait-9876abcd-1234-ef56-7890-abcdef123456",
63                  "trait_type": "string",
64                  "updated_at": "2024-01-05T11:00:00Z"
65                },
66                "trait_entity_type": "company",
67                "trait_id": "trait-9876abcd-1234-ef56-7890-abcdef123456"
68              }
69            ],
70            "created_at": "2024-01-15T09:30:00Z",
71            "environment_id": "env-prod-001",
72            "id": "cg-1234abcd-5678-ef90-1234-56789abcdef0",
73            "rule_id": "rule-9999aaaa-8888-bbbb-7777-cccc6666dddd",
74            "updated_at": "2024-01-15T09:30:00Z",
75            "flag_id": "flag-1234abcd-5678-ef90-1234-56789abcdef0"
76          }
77        ],
78        "conditions": [
79          {
80            "condition_type": "plan",
81            "created_at": "2024-01-15T09:30:00Z",
82            "environment_id": "env-prod-001",
83            "id": "cond-1111aaaa-2222-bbbb-3333-cccc4444dddd",
84            "operator": "eq",
85            "resource_ids": [
86              "res-5555eeee-6666-ffff-7777-gggg8888hhhh"
87            ],
88            "resources": [
89              {
90                "id": "res-5555eeee-6666-ffff-7777-gggg8888hhhh",
91                "name": "Enterprise",
92                "description": "Enterprise Plan",
93                "image_url": "https://example.com/images/enterprise_plan.png"
94              }
95            ],
96            "rule_id": "rule-9999aaaa-8888-bbbb-7777-cccc6666dddd",
97            "trait_value": "enterprise",
98            "updated_at": "2024-01-15T09:30:00Z",
99            "comparison_trait": {
100              "created_at": "2023-10-10T07:00:00Z",
101              "display_name": "Subscription Plan",
102              "entity_type": "company",
103              "hierarchy": [
104                "enterprise",
105                "premium"
106              ],
107              "id": "trait-9876abcd-1234-ef56-7890-abcdef123456",
108              "trait_type": "string",
109              "updated_at": "2024-01-05T11:00:00Z"
110            },
111            "comparison_trait_id": "trait-9876abcd-1234-ef56-7890-abcdef123456",
112            "condition_group_id": "cg-1234abcd-5678-ef90-1234-56789abcdef0",
113            "event_subtype": null,
114            "flag_id": "flag-1234abcd-5678-ef90-1234-56789abcdef0",
115            "metric_period": "all_time",
116            "metric_period_month_reset": "billing_cycle",
117            "metric_value": 0,
118            "trait": {
119              "created_at": "2023-10-10T07:00:00Z",
120              "display_name": "Subscription Plan",
121              "entity_type": "company",
122              "hierarchy": [
123                "enterprise",
124                "premium"
125              ],
126              "id": "trait-9876abcd-1234-ef56-7890-abcdef123456",
127              "trait_type": "string",
128              "updated_at": "2024-01-05T11:00:00Z"
129            },
130            "trait_entity_type": "company",
131            "trait_id": "trait-9876abcd-1234-ef56-7890-abcdef123456"
132          }
133        ],
134        "created_at": "2024-01-15T09:30:00Z",
135        "environment_id": "env-prod-001",
136        "id": "rule-9999aaaa-8888-bbbb-7777-cccc6666dddd",
137        "name": "Enterprise Plan Override",
138        "priority": 10,
139        "rule_type": "company_override",
140        "updated_at": "2024-01-15T09:30:00Z",
141        "value": true,
142        "flag_id": "flag-1234abcd-5678-ef90-1234-56789abcdef0"
143      }
144    ],
145    "updated_at": "2024-04-20T15:45:00Z",
146    "feature": {
147      "created_at": "2023-12-01T08:00:00Z",
148      "description": "Dark mode toggle for user interface",
149      "feature_type": "boolean",
150      "icon": "moon",
151      "id": "f8a1c2d4-3b6e-4f9a-9a2e-123456789abc",
152      "name": "Dark Mode",
153      "updated_at": "2024-01-10T12:00:00Z",
154      "event_subtype": null,
155      "lifecycle_phase": "beta",
156      "maintainer_account_member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
157      "plural_name": "Dark Modes",
158      "singular_name": "Dark Mode",
159      "trait_id": null
160    },
161    "feature_id": "f8a1c2d4-3b6e-4f9a-9a2e-123456789abc",
162    "last_checked_at": "2024-04-20T15:45:00Z",
163    "maintainer": {
164      "created_at": "2023-11-20T09:15:00Z",
165      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
166      "permissions": {
167        "features_edit": [
168          "flags_edit",
169          "flag_rules_edit"
170        ],
171        "plans_edit": [
172          "plan_versions_edit"
173        ]
174      },
175      "updated_at": "2024-04-01T10:00:00Z",
176      "email": "jane.doe@example.com",
177      "first_name": "Jane",
178      "image_url": "https://example.com/images/jane_doe.png",
179      "last_name": "Doe",
180      "name": "Jane Doe",
181      "role": "admin"
182    },
183    "maintainer_account_member_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
184  },
185  "params": {}
186}
Was this page helpful?
Previous

Create flag

Next
Built with

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Path parameters

flag_idstringRequired

flag_id

Response

OK
dataobject
paramsobject
Input parameters

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error