Get flag

GET

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

GET

/flags/:flag_id

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.features.getFlag("flag_id");

Try it

1 {
2   "data": {
3     "created_at": "2024-01-15T09:30:00Z",
4     "default_value": true,
5     "description": "string",
6     "flag_type": "string",
7     "id": "string",
8     "key": "string",
9     "name": "string",
10     "rules": [
11       {
12         "condition_groups": [
13           {
14             "conditions": [
15               {
16                 "condition_type": "string",
17                 "created_at": "2024-01-15T09:30:00Z",
18                 "environment_id": "string",
19                 "id": "string",
20                 "operator": "string",
21                 "resource_ids": [
22                   "string"
23                 ],
24                 "resources": [
25                   {
26                     "id": "string",
27                     "name": "string",
28                     "description": "string",
29                     "image_url": "string"
30                   }
31                 ],
32                 "rule_id": "string",
33                 "trait_value": "string",
34                 "updated_at": "2024-01-15T09:30:00Z",
35                 "comparison_trait": {
36                   "created_at": "2024-01-15T09:30:00Z",
37                   "display_name": "string",
38                   "entity_type": "string",
39                   "hierarchy": [
40                     "string"
41                   ],
42                   "id": "string",
43                   "trait_type": "string",
44                   "updated_at": "2024-01-15T09:30:00Z"
45                 },
46                 "comparison_trait_id": "string",
47                 "condition_group_id": "string",
48                 "event_subtype": "string",
49                 "flag_id": "string",
50                 "metric_period": "string",
51                 "metric_period_month_reset": "string",
52                 "metric_value": 1,
53                 "trait": {
54                   "created_at": "2024-01-15T09:30:00Z",
55                   "display_name": "string",
56                   "entity_type": "string",
57                   "hierarchy": [
58                     "string"
59                   ],
60                   "id": "string",
61                   "trait_type": "string",
62                   "updated_at": "2024-01-15T09:30:00Z"
63                 },
64                 "trait_entity_type": "string",
65                 "trait_id": "string"
66               }
67             ],
68             "created_at": "2024-01-15T09:30:00Z",
69             "environment_id": "string",
70             "id": "string",
71             "rule_id": "string",
72             "updated_at": "2024-01-15T09:30:00Z",
73             "flag_id": "string"
74           }
75         ],
76         "conditions": [
77           {
78             "condition_type": "string",
79             "created_at": "2024-01-15T09:30:00Z",
80             "environment_id": "string",
81             "id": "string",
82             "operator": "string",
83             "resource_ids": [
84               "string"
85             ],
86             "resources": [
87               {
88                 "id": "string",
89                 "name": "string",
90                 "description": "string",
91                 "image_url": "string"
92               }
93             ],
94             "rule_id": "string",
95             "trait_value": "string",
96             "updated_at": "2024-01-15T09:30:00Z",
97             "comparison_trait": {
98               "created_at": "2024-01-15T09:30:00Z",
99               "display_name": "string",
100               "entity_type": "string",
101               "hierarchy": [
102                 "string"
103               ],
104               "id": "string",
105               "trait_type": "string",
106               "updated_at": "2024-01-15T09:30:00Z"
107             },
108             "comparison_trait_id": "string",
109             "condition_group_id": "string",
110             "event_subtype": "string",
111             "flag_id": "string",
112             "metric_period": "string",
113             "metric_period_month_reset": "string",
114             "metric_value": 1,
115             "trait": {
116               "created_at": "2024-01-15T09:30:00Z",
117               "display_name": "string",
118               "entity_type": "string",
119               "hierarchy": [
120                 "string"
121               ],
122               "id": "string",
123               "trait_type": "string",
124               "updated_at": "2024-01-15T09:30:00Z"
125             },
126             "trait_entity_type": "string",
127             "trait_id": "string"
128           }
129         ],
130         "created_at": "2024-01-15T09:30:00Z",
131         "environment_id": "string",
132         "id": "string",
133         "name": "string",
134         "priority": 1,
135         "rule_type": "string",
136         "updated_at": "2024-01-15T09:30:00Z",
137         "value": true,
138         "flag_id": "string"
139       }
140     ],
141     "updated_at": "2024-01-15T09:30:00Z",
142     "feature": {
143       "created_at": "2024-01-15T09:30:00Z",
144       "description": "string",
145       "feature_type": "string",
146       "icon": "string",
147       "id": "string",
148       "name": "string",
149       "updated_at": "2024-01-15T09:30:00Z",
150       "event_subtype": "string",
151       "lifecycle_phase": "string",
152       "maintainer_id": "string",
153       "plural_name": "string",
154       "singular_name": "string",
155       "trait_id": "string"
156     },
157     "feature_id": "string",
158     "last_checked_at": "2024-01-15T09:30:00Z",
159     "maintainer_id": "string"
160   },
161   "params": {}
162 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

flag_idstringRequired

flag_id

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Response

Errors