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                 "plan_id": "string",
54                 "trait": {
55                   "created_at": "2024-01-15T09:30:00Z",
56                   "display_name": "string",
57                   "entity_type": "string",
58                   "hierarchy": [
59                     "string"
60                   ],
61                   "id": "string",
62                   "trait_type": "string",
63                   "updated_at": "2024-01-15T09:30:00Z"
64                 },
65                 "trait_entity_type": "string",
66                 "trait_id": "string"
67               }
68             ],
69             "created_at": "2024-01-15T09:30:00Z",
70             "environment_id": "string",
71             "id": "string",
72             "rule_id": "string",
73             "updated_at": "2024-01-15T09:30:00Z",
74             "flag_id": "string",
75             "plan_id": "string"
76           }
77         ],
78         "conditions": [
79           {
80             "condition_type": "string",
81             "created_at": "2024-01-15T09:30:00Z",
82             "environment_id": "string",
83             "id": "string",
84             "operator": "string",
85             "resource_ids": [
86               "string"
87             ],
88             "resources": [
89               {
90                 "id": "string",
91                 "name": "string",
92                 "description": "string",
93                 "image_url": "string"
94               }
95             ],
96             "rule_id": "string",
97             "trait_value": "string",
98             "updated_at": "2024-01-15T09:30:00Z",
99             "comparison_trait": {
100               "created_at": "2024-01-15T09:30:00Z",
101               "display_name": "string",
102               "entity_type": "string",
103               "hierarchy": [
104                 "string"
105               ],
106               "id": "string",
107               "trait_type": "string",
108               "updated_at": "2024-01-15T09:30:00Z"
109             },
110             "comparison_trait_id": "string",
111             "condition_group_id": "string",
112             "event_subtype": "string",
113             "flag_id": "string",
114             "metric_period": "string",
115             "metric_period_month_reset": "string",
116             "metric_value": 1,
117             "plan_id": "string",
118             "trait": {
119               "created_at": "2024-01-15T09:30:00Z",
120               "display_name": "string",
121               "entity_type": "string",
122               "hierarchy": [
123                 "string"
124               ],
125               "id": "string",
126               "trait_type": "string",
127               "updated_at": "2024-01-15T09:30:00Z"
128             },
129             "trait_entity_type": "string",
130             "trait_id": "string"
131           }
132         ],
133         "created_at": "2024-01-15T09:30:00Z",
134         "environment_id": "string",
135         "id": "string",
136         "name": "string",
137         "priority": 1,
138         "rule_type": "string",
139         "updated_at": "2024-01-15T09:30:00Z",
140         "value": true,
141         "flag_id": "string",
142         "plan_id": "string"
143       }
144     ],
145     "updated_at": "2024-01-15T09:30:00Z",
146     "feature": {
147       "created_at": "2024-01-15T09:30:00Z",
148       "description": "string",
149       "feature_type": "string",
150       "icon": "string",
151       "id": "string",
152       "name": "string",
153       "updated_at": "2024-01-15T09:30:00Z",
154       "event_subtype": "string",
155       "lifecycle_phase": "string",
156       "maintainer_id": "string",
157       "plural_name": "string",
158       "singular_name": "string",
159       "trait_id": "string"
160     },
161     "feature_id": "string",
162     "last_checked_at": "2024-01-15T09:30:00Z",
163     "maintainer_id": "string"
164   },
165   "params": {}
166 }

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