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-04-10T14:22:00Z",
5       "default_value": true,
6       "description": "Enables the new user onboarding flow",
7       "flag_type": "boolean",
8       "id": "flag_abcdef1234567890",
9       "key": "enable_user_onboarding",
10       "name": "Enable User Onboarding",
11       "rules": [
12         {
13           "condition_groups": [
14             {
15               "conditions": [
16                 {
17                   "condition_type": "plan",
18                   "created_at": "2024-02-15T11:00:00Z",
19                   "environment_id": "env_prod_001",
20                   "id": "cond_5566778899",
21                   "operator": "eq",
22                   "resource_ids": [
23                     "res_abc123"
24                   ],
25                   "resources": [
26                     {
27                       "id": "res_abc123",
28                       "name": "Pro Plan",
29                       "description": "Pro Plan subscription",
30                       "image_url": "https://example.com/images/pro_plan.png"
31                     }
32                   ],
33                   "rule_id": "rule_9988776655",
34                   "trait_value": "pro",
35                   "updated_at": "2024-02-15T11:00:00Z",
36                   "comparison_trait": {
37                     "created_at": "2023-11-20T07:30:00Z",
38                     "display_name": "Subscription Plan",
39                     "entity_type": "company",
40                     "hierarchy": [
41                       "plan",
42                       "subscription"
43                     ],
44                     "id": "trait_123plan456",
45                     "trait_type": "string",
46                     "updated_at": "2024-01-10T09:00:00Z"
47                   },
48                   "comparison_trait_id": "trait_123plan456",
49                   "condition_group_id": "condgrp_0011223344",
50                   "event_subtype": null,
51                   "flag_id": "flag_abcdef1234567890",
52                   "metric_period": "all_time",
53                   "metric_period_month_reset": "billing_cycle",
54                   "metric_value": 1,
55                   "trait": {
56                     "created_at": "2023-11-20T07:30:00Z",
57                     "display_name": "Subscription Plan",
58                     "entity_type": "company",
59                     "hierarchy": [
60                       "plan",
61                       "subscription"
62                     ],
63                     "id": "trait_123plan456",
64                     "trait_type": "string",
65                     "updated_at": "2024-01-10T09:00:00Z"
66                   },
67                   "trait_entity_type": "company",
68                   "trait_id": "trait_123plan456"
69                 }
70               ],
71               "created_at": "2024-02-15T11:00:00Z",
72               "environment_id": "env_prod_001",
73               "id": "condgrp_0011223344",
74               "rule_id": "rule_9988776655",
75               "updated_at": "2024-02-15T11:00:00Z",
76               "flag_id": "flag_abcdef1234567890"
77             }
78           ],
79           "conditions": [
80             {
81               "condition_type": "plan",
82               "created_at": "2024-02-15T11:00:00Z",
83               "environment_id": "env_prod_001",
84               "id": "cond_5566778899",
85               "operator": "eq",
86               "resource_ids": [
87                 "res_abc123"
88               ],
89               "resources": [
90                 {
91                   "id": "res_abc123",
92                   "name": "Pro Plan",
93                   "description": "Pro Plan subscription",
94                   "image_url": "https://example.com/images/pro_plan.png"
95                 }
96               ],
97               "rule_id": "rule_9988776655",
98               "trait_value": "pro",
99               "updated_at": "2024-02-15T11:00:00Z",
100               "comparison_trait": {
101                 "created_at": "2023-11-20T07:30:00Z",
102                 "display_name": "Subscription Plan",
103                 "entity_type": "company",
104                 "hierarchy": [
105                   "plan",
106                   "subscription"
107                 ],
108                 "id": "trait_123plan456",
109                 "trait_type": "string",
110                 "updated_at": "2024-01-10T09:00:00Z"
111               },
112               "comparison_trait_id": "trait_123plan456",
113               "condition_group_id": "condgrp_0011223344",
114               "event_subtype": null,
115               "flag_id": "flag_abcdef1234567890",
116               "metric_period": "all_time",
117               "metric_period_month_reset": "billing_cycle",
118               "metric_value": 1,
119               "trait": {
120                 "created_at": "2023-11-20T07:30:00Z",
121                 "display_name": "Subscription Plan",
122                 "entity_type": "company",
123                 "hierarchy": [
124                   "plan",
125                   "subscription"
126                 ],
127                 "id": "trait_123plan456",
128                 "trait_type": "string",
129                 "updated_at": "2024-01-10T09:00:00Z"
130               },
131               "trait_entity_type": "company",
132               "trait_id": "trait_123plan456"
133             }
134           ],
135           "created_at": "2024-02-15T11:00:00Z",
136           "environment_id": "env_prod_001",
137           "id": "rule_9988776655",
138           "name": "Enable for Pro Plan",
139           "priority": 10,
140           "rule_type": "company_override",
141           "updated_at": "2024-02-15T11:00:00Z",
142           "value": true,
143           "flag_id": "flag_abcdef1234567890"
144         }
145       ],
146       "updated_at": "2024-04-10T14:22:00Z",
147       "feature": {
148         "created_at": "2024-03-01T08:00:00Z",
149         "description": "User onboarding feature toggle",
150         "feature_type": "boolean",
151         "icon": "rocket",
152         "id": "feat_1234567890abcdef",
153         "name": "User Onboarding",
154         "updated_at": "2024-04-05T12:00:00Z",
155         "event_subtype": null,
156         "lifecycle_phase": "beta",
157         "maintainer_account_member_id": "acctmem_9876543210fedcba",
158         "plural_name": "User Onboardings",
159         "singular_name": "User Onboarding",
160         "trait_id": null
161       },
162       "feature_id": "feat_1234567890abcdef",
163       "last_checked_at": "2024-04-10T14:20:00Z",
164       "maintainer": {
165         "created_at": "2023-12-15T09:00:00Z",
166         "id": "acctmem_9876543210fedcba",
167         "permissions": {
168           "features_edit": [
169             "flags_edit",
170             "flag_rules_edit"
171           ],
172           "webhooks_edit": [
173             "webhooks_reveal_secret"
174           ]
175         },
176         "updated_at": "2024-04-01T10:00:00Z",
177         "email": "jane.doe@example.com",
178         "first_name": "Jane",
179         "image_url": "https://example.com/images/jane_doe.png",
180         "last_name": "Doe",
181         "name": "Jane Doe",
182         "role": "admin"
183       },
184       "maintainer_account_member_id": "acctmem_9876543210fedcba"
185     }
186   ],
187   "params": {
188     "feature_id": "feat_1234567890abcdef",
189     "ids": [
190       "flag_abcdef1234567890"
191     ],
192     "limit": 100,
193     "offset": 0,
194     "q": "onboarding"
195   }
196 }

import { SchematicClient } from "@schematichq/schematic-typescript-node";
async function main() {
    const client = new SchematicClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.features.listFlags({});
}
main();

{
  "data": [
    {
      "created_at": "2024-04-10T14:22:00Z",
      "default_value": true,
      "description": "Enables the new user onboarding flow",
      "flag_type": "boolean",
      "id": "flag_abcdef1234567890",
      "key": "enable_user_onboarding",
      "name": "Enable User Onboarding",
      "rules": [
        {
          "condition_groups": [
            {
              "conditions": [
                {
                  "condition_type": "plan",
                  "created_at": "2024-02-15T11:00:00Z",
                  "environment_id": "env_prod_001",
                  "id": "cond_5566778899",
                  "operator": "eq",
                  "resource_ids": [
                    "res_abc123"
                  ],
                  "resources": [
                    {
                      "id": "res_abc123",
                      "name": "Pro Plan",
                      "description": "Pro Plan subscription",
                      "image_url": "https://example.com/images/pro_plan.png"
                    }
                  ],
                  "rule_id": "rule_9988776655",
                  "trait_value": "pro",
                  "updated_at": "2024-02-15T11:00:00Z",
                  "comparison_trait": {
                    "created_at": "2023-11-20T07:30:00Z",
                    "display_name": "Subscription Plan",
                    "entity_type": "company",
                    "hierarchy": [
                      "plan",
                      "subscription"
                    ],
                    "id": "trait_123plan456",
                    "trait_type": "string",
                    "updated_at": "2024-01-10T09:00:00Z"
                  },
                  "comparison_trait_id": "trait_123plan456",
                  "condition_group_id": "condgrp_0011223344",
                  "event_subtype": null,
                  "flag_id": "flag_abcdef1234567890",
                  "metric_period": "all_time",
                  "metric_period_month_reset": "billing_cycle",
                  "metric_value": 1,
                  "trait": {
                    "created_at": "2023-11-20T07:30:00Z",
                    "display_name": "Subscription Plan",
                    "entity_type": "company",
                    "hierarchy": [
                      "plan",
                      "subscription"
                    ],
                    "id": "trait_123plan456",
                    "trait_type": "string",
                    "updated_at": "2024-01-10T09:00:00Z"
                  },
                  "trait_entity_type": "company",
                  "trait_id": "trait_123plan456"
                }
              ],
              "created_at": "2024-02-15T11:00:00Z",
              "environment_id": "env_prod_001",
              "id": "condgrp_0011223344",
              "rule_id": "rule_9988776655",
              "updated_at": "2024-02-15T11:00:00Z",
              "flag_id": "flag_abcdef1234567890"
            }
          ],
          "conditions": [
            {
              "condition_type": "plan",
              "created_at": "2024-02-15T11:00:00Z",
              "environment_id": "env_prod_001",
              "id": "cond_5566778899",
              "operator": "eq",
              "resource_ids": [
                "res_abc123"
              ],
              "resources": [
                {
                  "id": "res_abc123",
                  "name": "Pro Plan",
                  "description": "Pro Plan subscription",
                  "image_url": "https://example.com/images/pro_plan.png"
                }
              ],
              "rule_id": "rule_9988776655",
              "trait_value": "pro",
              "updated_at": "2024-02-15T11:00:00Z",
              "comparison_trait": {
                "created_at": "2023-11-20T07:30:00Z",
                "display_name": "Subscription Plan",
                "entity_type": "company",
                "hierarchy": [
                  "plan",
                  "subscription"
                ],
                "id": "trait_123plan456",
                "trait_type": "string",
                "updated_at": "2024-01-10T09:00:00Z"
              },
              "comparison_trait_id": "trait_123plan456",
              "condition_group_id": "condgrp_0011223344",
              "event_subtype": null,
              "flag_id": "flag_abcdef1234567890",
              "metric_period": "all_time",
              "metric_period_month_reset": "billing_cycle",
              "metric_value": 1,
              "trait": {
                "created_at": "2023-11-20T07:30:00Z",
                "display_name": "Subscription Plan",
                "entity_type": "company",
                "hierarchy": [
                  "plan",
                  "subscription"
                ],
                "id": "trait_123plan456",
                "trait_type": "string",
                "updated_at": "2024-01-10T09:00:00Z"
              },
              "trait_entity_type": "company",
              "trait_id": "trait_123plan456"
            }
          ],
          "created_at": "2024-02-15T11:00:00Z",
          "environment_id": "env_prod_001",
          "id": "rule_9988776655",
          "name": "Enable for Pro Plan",
          "priority": 10,
          "rule_type": "company_override",
          "updated_at": "2024-02-15T11:00:00Z",
          "value": true,
          "flag_id": "flag_abcdef1234567890"
        }
      ],
      "updated_at": "2024-04-10T14:22:00Z",
      "feature": {
        "created_at": "2024-03-01T08:00:00Z",
        "description": "User onboarding feature toggle",
        "feature_type": "boolean",
        "icon": "rocket",
        "id": "feat_1234567890abcdef",
        "name": "User Onboarding",
        "updated_at": "2024-04-05T12:00:00Z",
        "event_subtype": null,
        "lifecycle_phase": "beta",
        "maintainer_account_member_id": "acctmem_9876543210fedcba",
        "plural_name": "User Onboardings",
        "singular_name": "User Onboarding",
        "trait_id": null
      },
      "feature_id": "feat_1234567890abcdef",
      "last_checked_at": "2024-04-10T14:20:00Z",
      "maintainer": {
        "created_at": "2023-12-15T09:00:00Z",
        "id": "acctmem_9876543210fedcba",
        "permissions": {
          "features_edit": [
            "flags_edit",
            "flag_rules_edit"
          ],
          "webhooks_edit": [
            "webhooks_reveal_secret"
          ]
        },
        "updated_at": "2024-04-01T10:00:00Z",
        "email": "jane.doe@example.com",
        "first_name": "Jane",
        "image_url": "https://example.com/images/jane_doe.png",
        "last_name": "Doe",
        "name": "Jane Doe",
        "role": "admin"
      },
      "maintainer_account_member_id": "acctmem_9876543210fedcba"
    }
  ],
  "params": {
    "feature_id": "feat_1234567890abcdef",
    "ids": [
      "flag_abcdef1234567890"
    ],
    "limit": 100,
    "offset": 0,
    "q": "onboarding"
  }
}

List flags

List flags

Authentication

Query parameters

Response

Errors

Authentication

Query parameters

Response

Errors

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-04-10T14:22:00Z",
5	"default_value": true,
6	"description": "Enables the new user onboarding flow",
7	"flag_type": "boolean",
8	"id": "flag_abcdef1234567890",
9	"key": "enable_user_onboarding",
10	"name": "Enable User Onboarding",
11	"rules": [
12	{
13	"condition_groups": [
14	{
15	"conditions": [
16	{
17	"condition_type": "plan",
18	"created_at": "2024-02-15T11:00:00Z",
19	"environment_id": "env_prod_001",
20	"id": "cond_5566778899",
21	"operator": "eq",
22	"resource_ids": [
23	"res_abc123"
24	],
25	"resources": [
26	{
27	"id": "res_abc123",
28	"name": "Pro Plan",
29	"description": "Pro Plan subscription",
30	"image_url": "https://example.com/images/pro_plan.png"
31	}
32	],
33	"rule_id": "rule_9988776655",
34	"trait_value": "pro",
35	"updated_at": "2024-02-15T11:00:00Z",
36	"comparison_trait": {
37	"created_at": "2023-11-20T07:30:00Z",
38	"display_name": "Subscription Plan",
39	"entity_type": "company",
40	"hierarchy": [
41	"plan",
42	"subscription"
43	],
44	"id": "trait_123plan456",
45	"trait_type": "string",
46	"updated_at": "2024-01-10T09:00:00Z"
47	},
48	"comparison_trait_id": "trait_123plan456",
49	"condition_group_id": "condgrp_0011223344",
50	"event_subtype": null,
51	"flag_id": "flag_abcdef1234567890",
52	"metric_period": "all_time",
53	"metric_period_month_reset": "billing_cycle",
54	"metric_value": 1,
55	"trait": {
56	"created_at": "2023-11-20T07:30:00Z",
57	"display_name": "Subscription Plan",
58	"entity_type": "company",
59	"hierarchy": [
60	"plan",
61	"subscription"
62	],
63	"id": "trait_123plan456",
64	"trait_type": "string",
65	"updated_at": "2024-01-10T09:00:00Z"
66	},
67	"trait_entity_type": "company",
68	"trait_id": "trait_123plan456"
69	}
70	],
71	"created_at": "2024-02-15T11:00:00Z",
72	"environment_id": "env_prod_001",
73	"id": "condgrp_0011223344",
74	"rule_id": "rule_9988776655",
75	"updated_at": "2024-02-15T11:00:00Z",
76	"flag_id": "flag_abcdef1234567890"
77	}
78	],
79	"conditions": [
80	{
81	"condition_type": "plan",
82	"created_at": "2024-02-15T11:00:00Z",
83	"environment_id": "env_prod_001",
84	"id": "cond_5566778899",
85	"operator": "eq",
86	"resource_ids": [
87	"res_abc123"
88	],
89	"resources": [
90	{
91	"id": "res_abc123",
92	"name": "Pro Plan",
93	"description": "Pro Plan subscription",
94	"image_url": "https://example.com/images/pro_plan.png"
95	}
96	],
97	"rule_id": "rule_9988776655",
98	"trait_value": "pro",
99	"updated_at": "2024-02-15T11:00:00Z",
100	"comparison_trait": {
101	"created_at": "2023-11-20T07:30:00Z",
102	"display_name": "Subscription Plan",
103	"entity_type": "company",
104	"hierarchy": [
105	"plan",
106	"subscription"
107	],
108	"id": "trait_123plan456",
109	"trait_type": "string",
110	"updated_at": "2024-01-10T09:00:00Z"
111	},
112	"comparison_trait_id": "trait_123plan456",
113	"condition_group_id": "condgrp_0011223344",
114	"event_subtype": null,
115	"flag_id": "flag_abcdef1234567890",
116	"metric_period": "all_time",
117	"metric_period_month_reset": "billing_cycle",
118	"metric_value": 1,
119	"trait": {
120	"created_at": "2023-11-20T07:30:00Z",
121	"display_name": "Subscription Plan",
122	"entity_type": "company",
123	"hierarchy": [
124	"plan",
125	"subscription"
126	],
127	"id": "trait_123plan456",
128	"trait_type": "string",
129	"updated_at": "2024-01-10T09:00:00Z"
130	},
131	"trait_entity_type": "company",
132	"trait_id": "trait_123plan456"
133	}
134	],
135	"created_at": "2024-02-15T11:00:00Z",
136	"environment_id": "env_prod_001",
137	"id": "rule_9988776655",
138	"name": "Enable for Pro Plan",
139	"priority": 10,
140	"rule_type": "company_override",
141	"updated_at": "2024-02-15T11:00:00Z",
142	"value": true,
143	"flag_id": "flag_abcdef1234567890"
144	}
145	],
146	"updated_at": "2024-04-10T14:22:00Z",
147	"feature": {
148	"created_at": "2024-03-01T08:00:00Z",
149	"description": "User onboarding feature toggle",
150	"feature_type": "boolean",
151	"icon": "rocket",
152	"id": "feat_1234567890abcdef",
153	"name": "User Onboarding",
154	"updated_at": "2024-04-05T12:00:00Z",
155	"event_subtype": null,
156	"lifecycle_phase": "beta",
157	"maintainer_account_member_id": "acctmem_9876543210fedcba",
158	"plural_name": "User Onboardings",
159	"singular_name": "User Onboarding",
160	"trait_id": null
161	},
162	"feature_id": "feat_1234567890abcdef",
163	"last_checked_at": "2024-04-10T14:20:00Z",
164	"maintainer": {
165	"created_at": "2023-12-15T09:00:00Z",
166	"id": "acctmem_9876543210fedcba",
167	"permissions": {
168	"features_edit": [
169	"flags_edit",
170	"flag_rules_edit"
171	],
172	"webhooks_edit": [
173	"webhooks_reveal_secret"
174	]
175	},
176	"updated_at": "2024-04-01T10:00:00Z",
177	"email": "jane.doe@example.com",
178	"first_name": "Jane",
179	"image_url": "https://example.com/images/jane_doe.png",
180	"last_name": "Doe",
181	"name": "Jane Doe",
182	"role": "admin"
183	},
184	"maintainer_account_member_id": "acctmem_9876543210fedcba"
185	}
186	],
187	"params": {
188	"feature_id": "feat_1234567890abcdef",
189	"ids": [
190	"flag_abcdef1234567890"
191	],
192	"limit": 100,
193	"offset": 0,
194	"q": "onboarding"
195	}
196	}