List flags

GET

Query parameters

feature_idstringOptional

idsstringOptional

qstringOptional

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

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