Get feature

GET

https://api.schematichq.com/features/:feature_id

GET

/features/:feature_id

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

Try it

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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Path parameters

feature_idstringRequired

feature_id

Response

dataobject

paramsobject

Input parameters

Authentication

Path parameters

Response

Errors