List flags

GET

https://api.schematichq.com/flags

GET

/flags

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

Try it

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

Query parameters

feature_idstringOptional

idslist of stringsOptional

qstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List flags

Headers

Query parameters

Response

Errors