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

200Retrieved

1 {
2   "data": [
3     {
4       "created_at": "2024-04-10T14:22:00Z",
5       "default_value": true,
6       "description": "Enables the new user onboarding flow",
7       "flag_type": "boolean",
8       "id": "flag-9876wxyz",
9       "key": "enable_user_onboarding",
10       "name": "Enable User Onboarding",
11       "rules": [
12         {
13           "condition_groups": [
14             {
15               "conditions": [
16                 {
17                   "condition_type": "equals",
18                   "created_at": "2024-04-01T11:00:00Z",
19                   "environment_id": "env-prod-0001",
20                   "id": "cond-3333cccc",
21                   "operator": "equals",
22                   "resource_ids": [
23                     "res-4444dddd"
24                   ],
25                   "resources": [
26                     {
27                       "id": "res-4444dddd",
28                       "name": "Premium Tier",
29                       "description": "Premium subscription tier",
30                       "image_url": "https://example.com/images/premium-tier.png"
31                     }
32                   ],
33                   "rule_id": "rule-5555eeee",
34                   "trait_value": "premium",
35                   "updated_at": "2024-04-01T11:00:00Z",
36                   "comparison_trait": {
37                     "created_at": "2024-02-15T08:00:00Z",
38                     "display_name": "Company Tier",
39                     "entity_type": "company",
40                     "hierarchy": [
41                       "subscription",
42                       "tier"
43                     ],
44                     "id": "trait-1111aaaa",
45                     "trait_type": "string",
46                     "updated_at": "2024-03-01T09:00:00Z"
47                   },
48                   "comparison_trait_id": "trait-1111aaaa",
49                   "condition_group_id": "condgrp-2222bbbb",
50                   "event_subtype": null,
51                   "flag_id": "flag-9876wxyz",
52                   "metric_period": null,
53                   "metric_period_month_reset": null,
54                   "metric_value": null,
55                   "trait": {
56                     "created_at": "2024-02-15T08:00:00Z",
57                     "display_name": "Company Tier",
58                     "entity_type": "company",
59                     "hierarchy": [
60                       "subscription",
61                       "tier"
62                     ],
63                     "id": "trait-1111aaaa",
64                     "trait_type": "string",
65                     "updated_at": "2024-03-01T09:00:00Z"
66                   },
67                   "trait_entity_type": "company",
68                   "trait_id": "trait-1111aaaa"
69                 }
70               ],
71               "created_at": "2024-04-01T11:00:00Z",
72               "environment_id": "env-prod-0001",
73               "id": "condgrp-2222bbbb",
74               "rule_id": "rule-5555eeee",
75               "updated_at": "2024-04-01T11:00:00Z",
76               "flag_id": "flag-9876wxyz"
77             }
78           ],
79           "conditions": [
80             {
81               "condition_type": "equals",
82               "created_at": "2024-04-01T11:00:00Z",
83               "environment_id": "env-prod-0001",
84               "id": "cond-6666ffff",
85               "operator": "equals",
86               "resource_ids": [
87                 "res-4444dddd"
88               ],
89               "resources": [
90                 {
91                   "id": "res-4444dddd",
92                   "name": "Premium Tier",
93                   "description": "Premium subscription tier",
94                   "image_url": "https://example.com/images/premium-tier.png"
95                 }
96               ],
97               "rule_id": "rule-5555eeee",
98               "trait_value": "premium",
99               "updated_at": "2024-04-01T11:00:00Z",
100               "comparison_trait": {
101                 "created_at": "2024-02-15T08:00:00Z",
102                 "display_name": "Company Tier",
103                 "entity_type": "company",
104                 "hierarchy": [
105                   "subscription",
106                   "tier"
107                 ],
108                 "id": "trait-1111aaaa",
109                 "trait_type": "string",
110                 "updated_at": "2024-03-01T09:00:00Z"
111               },
112               "comparison_trait_id": "trait-1111aaaa",
113               "condition_group_id": null,
114               "event_subtype": null,
115               "flag_id": "flag-9876wxyz",
116               "metric_period": null,
117               "metric_period_month_reset": null,
118               "metric_value": null,
119               "trait": {
120                 "created_at": "2024-02-15T08:00:00Z",
121                 "display_name": "Company Tier",
122                 "entity_type": "company",
123                 "hierarchy": [
124                   "subscription",
125                   "tier"
126                 ],
127                 "id": "trait-1111aaaa",
128                 "trait_type": "string",
129                 "updated_at": "2024-03-01T09:00:00Z"
130               },
131               "trait_entity_type": "company",
132               "trait_id": "trait-1111aaaa"
133             }
134           ],
135           "created_at": "2024-04-01T10:00:00Z",
136           "environment_id": "env-prod-0001",
137           "id": "rule-5555eeee",
138           "name": "Premium Tier Rule",
139           "priority": 1,
140           "rule_type": "percentage_rollout",
141           "updated_at": "2024-04-01T12:00:00Z",
142           "value": true,
143           "flag_id": "flag-9876wxyz"
144         }
145       ],
146       "updated_at": "2024-04-10T14:22:00Z",
147       "feature": {
148         "created_at": "2024-03-01T10:00:00Z",
149         "description": "User onboarding features",
150         "feature_type": "boolean",
151         "icon": "user-plus",
152         "id": "feat-1234abcd",
153         "name": "User Onboarding",
154         "updated_at": "2024-04-01T12:00:00Z",
155         "event_subtype": null,
156         "lifecycle_phase": "beta",
157         "maintainer_id": "maint-5678efgh",
158         "plural_name": "User Onboardings",
159         "singular_name": "User Onboarding",
160         "trait_id": null
161       },
162       "feature_id": "feat-1234abcd",
163       "last_checked_at": "2024-04-10T14:20:00Z",
164       "maintainer_id": "maint-5678efgh"
165     }
166   ],
167   "params": {
168     "feature_id": "feat-1234abcd",
169     "ids": [
170       "flag-9876wxyz"
171     ],
172     "limit": 100,
173     "offset": 0,
174     "q": "user onboarding"
175   }
176 }

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

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors