List flags

GET

Query parameters

feature_idstringOptional

idsstringOptional

qstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

This endpoint returns an object

datalist of objects

The returned resources

paramsobject

Input parameters

GET

1 curl https://api.schematichq.com/flags \
2      -H "X-Schematic-Api-Key: <apiKey>"

200Retrieved

1 {
2   "data": [
3     {
4       "created_at": "2024-01-15T09:30:00Z",
5       "default_value": true,
6       "description": "description",
7       "feature": {
8         "created_at": "2024-01-15T09:30:00Z",
9         "description": "description",
10         "feature_type": "feature_type",
11         "icon": "icon",
12         "id": "id",
13         "name": "name",
14         "updated_at": "2024-01-15T09:30:00Z"
15       },
16       "feature_id": "feature_id",
17       "flag_type": "flag_type",
18       "id": "id",
19       "key": "key",
20       "last_checked_at": "2024-01-15T09:30:00Z",
21       "maintainer_id": "maintainer_id",
22       "name": "name",
23       "rules": [
24         {
25           "condition_groups": [
26             {
27               "conditions": [
28                 {
29                   "condition_type": "condition_type",
30                   "created_at": "2024-01-15T09:30:00Z",
31                   "environment_id": "environment_id",
32                   "id": "id",
33                   "operator": "operator",
34                   "resource_ids": [
35                     "resource_ids"
36                   ],
37                   "resources": [
38                     {
39                       "id": "id",
40                       "name": "name"
41                     }
42                   ],
43                   "rule_id": "rule_id",
44                   "trait_value": "trait_value",
45                   "updated_at": "2024-01-15T09:30:00Z"
46                 }
47               ],
48               "created_at": "2024-01-15T09:30:00Z",
49               "environment_id": "environment_id",
50               "id": "id",
51               "rule_id": "rule_id",
52               "updated_at": "2024-01-15T09:30:00Z"
53             }
54           ],
55           "conditions": [
56             {
57               "condition_type": "condition_type",
58               "created_at": "2024-01-15T09:30:00Z",
59               "environment_id": "environment_id",
60               "id": "id",
61               "operator": "operator",
62               "resource_ids": [
63                 "resource_ids"
64               ],
65               "resources": [
66                 {
67                   "id": "id",
68                   "name": "name"
69                 }
70               ],
71               "rule_id": "rule_id",
72               "trait_value": "trait_value",
73               "updated_at": "2024-01-15T09:30:00Z"
74             }
75           ],
76           "created_at": "2024-01-15T09:30:00Z",
77           "environment_id": "environment_id",
78           "id": "id",
79           "name": "name",
80           "priority": 1,
81           "rule_type": "rule_type",
82           "updated_at": "2024-01-15T09:30:00Z",
83           "value": true
84         }
85       ],
86       "updated_at": "2024-01-15T09:30:00Z"
87     }
88   ],
89   "params": {
90     "feature_id": "feature_id",
91     "ids": [
92       "ids"
93     ],
94     "limit": 1,
95     "offset": 1,
96     "q": "q"
97   }
98 }

Built with

1	curl https://api.schematichq.com/flags \
2	-H "X-Schematic-Api-Key: <apiKey>"

1	{
2	"data": [
3	{
4	"created_at": "2024-01-15T09:30:00Z",
5	"default_value": true,
6	"description": "description",
7	"feature": {
8	"created_at": "2024-01-15T09:30:00Z",
9	"description": "description",
10	"feature_type": "feature_type",
11	"icon": "icon",
12	"id": "id",
13	"name": "name",
14	"updated_at": "2024-01-15T09:30:00Z"
15	},
16	"feature_id": "feature_id",
17	"flag_type": "flag_type",
18	"id": "id",
19	"key": "key",
20	"last_checked_at": "2024-01-15T09:30:00Z",
21	"maintainer_id": "maintainer_id",
22	"name": "name",
23	"rules": [
24	{
25	"condition_groups": [
26	{
27	"conditions": [
28	{
29	"condition_type": "condition_type",
30	"created_at": "2024-01-15T09:30:00Z",
31	"environment_id": "environment_id",
32	"id": "id",
33	"operator": "operator",
34	"resource_ids": [
35	"resource_ids"
36	],
37	"resources": [
38	{
39	"id": "id",
40	"name": "name"
41	}
42	],
43	"rule_id": "rule_id",
44	"trait_value": "trait_value",
45	"updated_at": "2024-01-15T09:30:00Z"
46	}
47	],
48	"created_at": "2024-01-15T09:30:00Z",
49	"environment_id": "environment_id",
50	"id": "id",
51	"rule_id": "rule_id",
52	"updated_at": "2024-01-15T09:30:00Z"
53	}
54	],
55	"conditions": [
56	{
57	"condition_type": "condition_type",
58	"created_at": "2024-01-15T09:30:00Z",
59	"environment_id": "environment_id",
60	"id": "id",
61	"operator": "operator",
62	"resource_ids": [
63	"resource_ids"
64	],
65	"resources": [
66	{
67	"id": "id",
68	"name": "name"
69	}
70	],
71	"rule_id": "rule_id",
72	"trait_value": "trait_value",
73	"updated_at": "2024-01-15T09:30:00Z"
74	}
75	],
76	"created_at": "2024-01-15T09:30:00Z",
77	"environment_id": "environment_id",
78	"id": "id",
79	"name": "name",
80	"priority": 1,
81	"rule_type": "rule_type",
82	"updated_at": "2024-01-15T09:30:00Z",
83	"value": true
84	}
85	],
86	"updated_at": "2024-01-15T09:30:00Z"
87	}
88	],
89	"params": {
90	"feature_id": "feature_id",
91	"ids": [
92	"ids"
93	],
94	"limit": 1,
95	"offset": 1,
96	"q": "q"
97	}
98	}