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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

feature_idstringOptional

idslist of stringsOptional

qstringOptional

Search by flag name, key, or ID

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors