List features

GET

https://api.schematichq.com/features

GET

/features

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

Try it

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

Query parameters

idslist of stringsOptional

qstringOptional

without_company_override_forstringOptional

Filter out features that already have a company override for the specified company ID

without_plan_entitlement_forstringOptional

Filter out features that already have a plan entitlement for the specified plan ID

feature_typelist of stringsOptional

Filter by one or more feature types (boolean, event, trait)

boolean_require_eventbooleanOptional

Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter.

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List features

Headers

Query parameters

Response

Errors