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": "2024-01-15T09:30:00Z",
5       "description": "description",
6       "feature_type": "feature_type",
7       "flags": [
8         {
9           "created_at": "2024-01-15T09:30:00Z",
10           "default_value": true,
11           "description": "description",
12           "flag_type": "flag_type",
13           "id": "id",
14           "key": "key",
15           "name": "name",
16           "rules": [
17             {
18               "condition_groups": [
19                 {
20                   "conditions": [
21                     {
22                       "condition_type": "condition_type",
23                       "created_at": "2024-01-15T09:30:00Z",
24                       "environment_id": "environment_id",
25                       "id": "id",
26                       "operator": "operator",
27                       "resource_ids": [
28                         "resource_ids"
29                       ],
30                       "resources": [
31                         {
32                           "id": "id",
33                           "name": "name"
34                         }
35                       ],
36                       "rule_id": "rule_id",
37                       "trait_value": "trait_value",
38                       "updated_at": "2024-01-15T09:30:00Z"
39                     }
40                   ],
41                   "created_at": "2024-01-15T09:30:00Z",
42                   "environment_id": "environment_id",
43                   "id": "id",
44                   "rule_id": "rule_id",
45                   "updated_at": "2024-01-15T09:30:00Z"
46                 }
47               ],
48               "conditions": [
49                 {
50                   "condition_type": "condition_type",
51                   "created_at": "2024-01-15T09:30:00Z",
52                   "environment_id": "environment_id",
53                   "id": "id",
54                   "operator": "operator",
55                   "resource_ids": [
56                     "resource_ids"
57                   ],
58                   "resources": [
59                     {
60                       "id": "id",
61                       "name": "name"
62                     }
63                   ],
64                   "rule_id": "rule_id",
65                   "trait_value": "trait_value",
66                   "updated_at": "2024-01-15T09:30:00Z"
67                 }
68               ],
69               "created_at": "2024-01-15T09:30:00Z",
70               "environment_id": "environment_id",
71               "id": "id",
72               "name": "name",
73               "priority": 1,
74               "rule_type": "rule_type",
75               "updated_at": "2024-01-15T09:30:00Z",
76               "value": true
77             }
78           ],
79           "updated_at": "2024-01-15T09:30:00Z"
80         }
81       ],
82       "icon": "icon",
83       "id": "id",
84       "name": "name",
85       "plans": [
86         {
87           "id": "id",
88           "name": "name"
89         }
90       ],
91       "updated_at": "2024-01-15T09:30:00Z",
92       "event_subtype": "event_subtype",
93       "event_summary": {
94         "company_count": 1,
95         "environment_id": "environment_id",
96         "event_count": 1,
97         "event_subtype": "event_subtype",
98         "user_count": 1
99       },
100       "lifecycle_phase": "lifecycle_phase",
101       "maintainer_id": "maintainer_id",
102       "plural_name": "plural_name",
103       "singular_name": "singular_name",
104       "trait": {
105         "created_at": "2024-01-15T09:30:00Z",
106         "display_name": "display_name",
107         "entity_type": "entity_type",
108         "hierarchy": [
109           "hierarchy"
110         ],
111         "id": "id",
112         "trait_type": "trait_type",
113         "updated_at": "2024-01-15T09:30:00Z"
114       },
115       "trait_id": "trait_id"
116     }
117   ],
118   "params": {
119     "ids": [
120       "ids"
121     ],
122     "limit": 1,
123     "offset": 1,
124     "q": "q",
125     "without_company_override_for": "without_company_override_for",
126     "without_plan_entitlement_for": "without_plan_entitlement_for"
127   }
128 }

Query parameters

idsstringOptional

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

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