Get flag

GET

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

GET

/flags/:flag_id

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.features.getFlag("flag_id");
8 }
9 main();

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "default_value": true,
5     "description": "Enable dark mode feature flag for UI customization",
6     "flag_type": "boolean",
7     "id": "flag-5678abcd-1234-ef56-7890-abcd1234ef56",
8     "key": "dark_mode_enabled",
9     "name": "Dark Mode Flag",
10     "rules": [
11       {
12         "condition_groups": [
13           {
14             "conditions": [
15               {
16                 "condition_type": "equals",
17                 "created_at": "2024-01-12T10:00:00Z",
18                 "environment_id": "env-prod-001",
19                 "id": "cond-2222bbbb-3333-cccc-4444-dddd5555eeee",
20                 "operator": "equals",
21                 "resource_ids": [
22                   "user-1234"
23                 ],
24                 "resources": [
25                   {
26                     "id": "user-1234",
27                     "name": "Jane Doe",
28                     "description": "Premium user account",
29                     "image_url": "https://example.com/images/users/user-1234.png"
30                   }
31                 ],
32                 "rule_id": "rule-3333cccc-4444-dddd-5555-eeee6666ffff",
33                 "trait_value": "true",
34                 "updated_at": "2024-01-12T10:00:00Z",
35                 "comparison_trait": {
36                   "created_at": "2023-11-20T07:45:00Z",
37                   "display_name": "User Subscription Status",
38                   "entity_type": "user",
39                   "hierarchy": [
40                     "account",
41                     "subscription"
42                   ],
43                   "id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56",
44                   "trait_type": "boolean",
45                   "updated_at": "2024-01-10T11:00:00Z"
46                 },
47                 "comparison_trait_id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56",
48                 "condition_group_id": "condgrp-1111aaaa-2222-bbbb-3333-cccc4444dddd",
49                 "flag_id": "flag-5678abcd-1234-ef56-7890-abcd1234ef56",
50                 "trait": {
51                   "created_at": "2023-11-20T07:45:00Z",
52                   "display_name": "User Subscription Status",
53                   "entity_type": "user",
54                   "hierarchy": [
55                     "account",
56                     "subscription"
57                   ],
58                   "id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56",
59                   "trait_type": "boolean",
60                   "updated_at": "2024-01-10T11:00:00Z"
61                 },
62                 "trait_entity_type": "user",
63                 "trait_id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56"
64               }
65             ],
66             "created_at": "2024-01-12T09:55:00Z",
67             "environment_id": "env-prod-001",
68             "id": "condgrp-1111aaaa-2222-bbbb-3333-cccc4444dddd",
69             "rule_id": "rule-3333cccc-4444-dddd-5555-eeee6666ffff",
70             "updated_at": "2024-01-12T10:05:00Z",
71             "flag_id": "flag-5678abcd-1234-ef56-7890-abcd1234ef56"
72           }
73         ],
74         "conditions": [
75           {
76             "condition_type": "equals",
77             "created_at": "2024-01-12T10:00:00Z",
78             "environment_id": "env-prod-001",
79             "id": "cond-2222bbbb-3333-cccc-4444-dddd5555eeee",
80             "operator": "equals",
81             "resource_ids": [
82               "user-1234"
83             ],
84             "resources": [
85               {
86                 "id": "user-1234",
87                 "name": "Jane Doe",
88                 "description": "Premium user account",
89                 "image_url": "https://example.com/images/users/user-1234.png"
90               }
91             ],
92             "rule_id": "rule-3333cccc-4444-dddd-5555-eeee6666ffff",
93             "trait_value": "true",
94             "updated_at": "2024-01-12T10:00:00Z",
95             "comparison_trait": {
96               "created_at": "2023-11-20T07:45:00Z",
97               "display_name": "User Subscription Status",
98               "entity_type": "user",
99               "hierarchy": [
100                 "account",
101                 "subscription"
102               ],
103               "id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56",
104               "trait_type": "boolean",
105               "updated_at": "2024-01-10T11:00:00Z"
106             },
107             "comparison_trait_id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56",
108             "flag_id": "flag-5678abcd-1234-ef56-7890-abcd1234ef56",
109             "trait": {
110               "created_at": "2023-11-20T07:45:00Z",
111               "display_name": "User Subscription Status",
112               "entity_type": "user",
113               "hierarchy": [
114                 "account",
115                 "subscription"
116               ],
117               "id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56",
118               "trait_type": "boolean",
119               "updated_at": "2024-01-10T11:00:00Z"
120             },
121             "trait_entity_type": "user",
122             "trait_id": "trait-7890abcd-1234-ef56-7890-abcd1234ef56"
123           }
124         ],
125         "created_at": "2024-01-12T09:50:00Z",
126         "environment_id": "env-prod-001",
127         "id": "rule-3333cccc-4444-dddd-5555-eeee6666ffff",
128         "name": "Enable for Premium Users",
129         "priority": 10,
130         "rule_type": "targeting",
131         "updated_at": "2024-01-12T10:10:00Z",
132         "value": true,
133         "flag_id": "flag-5678abcd-1234-ef56-7890-abcd1234ef56"
134       }
135     ],
136     "updated_at": "2024-01-15T09:30:00Z",
137     "feature": {
138       "created_at": "2023-12-01T08:00:00Z",
139       "description": "Dark mode toggle for user interface",
140       "feature_type": "boolean",
141       "icon": "moon",
142       "id": "f8a1c2d4-3b6e-4f9a-9a2e-1c2d3e4f5a6b",
143       "name": "Dark Mode",
144       "updated_at": "2024-01-10T12:00:00Z",
145       "lifecycle_phase": "beta",
146       "maintainer_id": "user-1234",
147       "plural_name": "Dark Modes",
148       "singular_name": "Dark Mode"
149     },
150     "feature_id": "f8a1c2d4-3b6e-4f9a-9a2e-1c2d3e4f5a6b",
151     "last_checked_at": "2024-01-15T09:00:00Z",
152     "maintainer_id": "user-1234"
153   },
154   "params": {}
155 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

flag_idstringRequired

flag_id

Response

dataobject

paramsobject

Input parameters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error