List flags

GET

https://api.schematichq.com/flags

GET

/flags

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.features.listFlags({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "created_at": "2024-01-15T09:30:00Z",
5       "default_value": true,
6       "description": "Enable dark mode for the application UI",
7       "flag_type": "boolean",
8       "id": "flag_abcdef1234567890",
9       "key": "dark_mode_enabled",
10       "name": "Dark Mode Flag",
11       "rules": [
12         {
13           "condition_groups": [
14             {
15               "conditions": [
16                 {
17                   "condition_type": "equals",
18                   "created_at": "2024-01-15T09:30:00Z",
19                   "environment_id": "env_prod_001",
20                   "id": "cond_001",
21                   "operator": "equals",
22                   "resource_ids": [
23                     "res_001"
24                   ],
25                   "resources": [
26                     {
27                       "id": "res_001",
28                       "name": "Premium Subscription",
29                       "description": "Premium subscription resource",
30                       "image_url": "https://example.com/images/premium.png"
31                     }
32                   ],
33                   "rule_id": "rule_001",
34                   "trait_value": "true",
35                   "updated_at": "2024-01-15T09:30:00Z",
36                   "comparison_trait": {
37                     "created_at": "2023-11-20T07:00:00Z",
38                     "display_name": "User Subscription Status",
39                     "entity_type": "user",
40                     "hierarchy": [
41                       "account",
42                       "subscription"
43                     ],
44                     "id": "trait_sub_status_001",
45                     "trait_type": "boolean",
46                     "updated_at": "2024-01-05T09:00:00Z"
47                   },
48                   "comparison_trait_id": "trait_sub_status_001",
49                   "condition_group_id": "condgrp_001",
50                   "flag_id": "flag_abcdef1234567890",
51                   "trait": {
52                     "created_at": "2023-11-20T07:00:00Z",
53                     "display_name": "User Subscription Status",
54                     "entity_type": "user",
55                     "hierarchy": [
56                       "account",
57                       "subscription"
58                     ],
59                     "id": "trait_sub_status_001",
60                     "trait_type": "boolean",
61                     "updated_at": "2024-01-05T09:00:00Z"
62                   },
63                   "trait_entity_type": "user",
64                   "trait_id": "trait_sub_status_001"
65                 }
66               ],
67               "created_at": "2024-01-15T09:30:00Z",
68               "environment_id": "env_prod_001",
69               "id": "condgrp_001",
70               "rule_id": "rule_001",
71               "updated_at": "2024-01-15T09:30:00Z",
72               "flag_id": "flag_abcdef1234567890"
73             }
74           ],
75           "conditions": [
76             {
77               "condition_type": "equals",
78               "created_at": "2024-01-15T09:30:00Z",
79               "environment_id": "env_prod_001",
80               "id": "cond_002",
81               "operator": "equals",
82               "resource_ids": [
83                 "res_001"
84               ],
85               "resources": [
86                 {
87                   "id": "res_001",
88                   "name": "Premium Subscription",
89                   "description": "Premium subscription resource",
90                   "image_url": "https://example.com/images/premium.png"
91                 }
92               ],
93               "rule_id": "rule_001",
94               "trait_value": "true",
95               "updated_at": "2024-01-15T09:30:00Z",
96               "comparison_trait": {
97                 "created_at": "2023-11-20T07:00:00Z",
98                 "display_name": "User Subscription Status",
99                 "entity_type": "user",
100                 "hierarchy": [
101                   "account",
102                   "subscription"
103                 ],
104                 "id": "trait_sub_status_001",
105                 "trait_type": "boolean",
106                 "updated_at": "2024-01-05T09:00:00Z"
107               },
108               "comparison_trait_id": "trait_sub_status_001",
109               "flag_id": "flag_abcdef1234567890",
110               "trait": {
111                 "created_at": "2023-11-20T07:00:00Z",
112                 "display_name": "User Subscription Status",
113                 "entity_type": "user",
114                 "hierarchy": [
115                   "account",
116                   "subscription"
117                 ],
118                 "id": "trait_sub_status_001",
119                 "trait_type": "boolean",
120                 "updated_at": "2024-01-05T09:00:00Z"
121               },
122               "trait_entity_type": "user",
123               "trait_id": "trait_sub_status_001"
124             }
125           ],
126           "created_at": "2024-01-15T09:30:00Z",
127           "environment_id": "env_prod_001",
128           "id": "rule_001",
129           "name": "Enable for Premium Users",
130           "priority": 1,
131           "rule_type": "targeting",
132           "updated_at": "2024-01-15T09:30:00Z",
133           "value": true,
134           "flag_id": "flag_abcdef1234567890"
135         }
136       ],
137       "updated_at": "2024-04-20T15:45:00Z",
138       "feature": {
139         "created_at": "2023-12-01T08:00:00Z",
140         "description": "Dark mode feature toggle",
141         "feature_type": "boolean",
142         "icon": "🌙",
143         "id": "feat_1234567890abcdef",
144         "name": "Dark Mode",
145         "updated_at": "2024-01-10T12:00:00Z",
146         "lifecycle_phase": "beta",
147         "maintainer_id": "user_9876543210fedcba",
148         "plural_name": "Dark Modes",
149         "singular_name": "Dark Mode"
150       },
151       "feature_id": "feat_1234567890abcdef",
152       "last_checked_at": "2024-04-20T15:45:00Z",
153       "maintainer_id": "user_9876543210fedcba"
154     }
155   ],
156   "params": {
157     "feature_id": "feat_1234567890abcdef",
158     "ids": [
159       "flag_abcdef1234567890"
160     ],
161     "limit": 100,
162     "offset": 0,
163     "q": "dark_mode"
164   }
165 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

feature_idstringOptional

idslist of stringsOptional

qstringOptional<=512 characters

Search by flag name, key, or ID

limitlongOptional

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error