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({
5     featureId: "feature_id",
6     q: "q",
7     limit: 1,
8     offset: 1
9 });

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

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