List company overrides

GET

Query parameters

company_idstringOptional

Filter company overrides by a single company ID (starting with comp_)

company_idsstringOptional

Filter company overrides by multiple company IDs (starting with comp_)

feature_idstringOptional

Filter company overrides by a single feature ID (starting with feat_)

feature_idsstringOptional

Filter company overrides by multiple feature IDs (starting with feat_)

idsstringOptional

Filter company overrides by multiple company override IDs (starting with cmov_)

qstringOptional

Search for company overrides by feature or company name

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/company-overrides \
2      -H "X-Schematic-Api-Key: <apiKey>"

200Retrieved

1 {
2   "data": [
3     {
4       "company_id": "company_id",
5       "created_at": "2024-01-15T09:30:00Z",
6       "environment_id": "environment_id",
7       "feature_id": "feature_id",
8       "id": "id",
9       "updated_at": "2024-01-15T09:30:00Z",
10       "value_type": "value_type",
11       "company": {
12         "add_ons": [
13           {
14             "id": "id",
15             "name": "name"
16           }
17         ],
18         "billing_subscriptions": [
19           {
20             "created_at": "2024-01-15T09:30:00Z",
21             "currency": "currency",
22             "customer_external_id": "customer_external_id",
23             "id": "id",
24             "interval": "interval",
25             "period_end": 1,
26             "period_start": 1,
27             "products": [
28               {
29                 "created_at": "2024-01-15T09:30:00Z",
30                 "currency": "currency",
31                 "environment_id": "environment_id",
32                 "external_id": "external_id",
33                 "id": "id",
34                 "interval": "interval",
35                 "name": "name",
36                 "price": 1,
37                 "price_external_id": "price_external_id",
38                 "quantity": 1.1,
39                 "subscription_id": "subscription_id",
40                 "updated_at": "2024-01-15T09:30:00Z",
41                 "usage_type": "usage_type"
42               }
43             ],
44             "status": "status",
45             "subscription_external_id": "subscription_external_id",
46             "total_price": 1
47           }
48         ],
49         "created_at": "2024-01-15T09:30:00Z",
50         "entity_traits": [
51           {
52             "created_at": "2024-01-15T09:30:00Z",
53             "definition_id": "definition_id",
54             "environment_id": "environment_id",
55             "id": "id",
56             "updated_at": "2024-01-15T09:30:00Z",
57             "value": "value"
58           }
59         ],
60         "environment_id": "environment_id",
61         "id": "id",
62         "keys": [
63           {
64             "created_at": "2024-01-15T09:30:00Z",
65             "definition_id": "definition_id",
66             "entity_id": "entity_id",
67             "entity_type": "entity_type",
68             "environment_id": "environment_id",
69             "id": "id",
70             "key": "key",
71             "updated_at": "2024-01-15T09:30:00Z",
72             "value": "value"
73           }
74         ],
75         "name": "name",
76         "plans": [
77           {
78             "id": "id",
79             "name": "name"
80           }
81         ],
82         "updated_at": "2024-01-15T09:30:00Z",
83         "user_count": 1
84       },
85       "expiration_date": "2024-01-15T09:30:00Z",
86       "feature": {
87         "created_at": "2024-01-15T09:30:00Z",
88         "description": "description",
89         "feature_type": "feature_type",
90         "icon": "icon",
91         "id": "id",
92         "name": "name",
93         "updated_at": "2024-01-15T09:30:00Z"
94       },
95       "metric_period": "metric_period",
96       "metric_period_month_reset": "metric_period_month_reset",
97       "rule_id": "rule_id",
98       "value_bool": true,
99       "value_numeric": 1,
100       "value_trait": {
101         "created_at": "2024-01-15T09:30:00Z",
102         "display_name": "display_name",
103         "entity_type": "entity_type",
104         "hierarchy": [
105           "hierarchy"
106         ],
107         "id": "id",
108         "trait_type": "trait_type",
109         "updated_at": "2024-01-15T09:30:00Z"
110       },
111       "value_trait_id": "value_trait_id"
112     }
113   ],
114   "params": {
115     "company_id": "company_id",
116     "company_ids": [
117       "company_ids"
118     ],
119     "feature_id": "feature_id",
120     "feature_ids": [
121       "feature_ids"
122     ],
123     "ids": [
124       "ids"
125     ],
126     "limit": 1,
127     "offset": 1,
128     "q": "q"
129   }
130 }

Built with

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

1	{
2	"data": [
3	{
4	"company_id": "company_id",
5	"created_at": "2024-01-15T09:30:00Z",
6	"environment_id": "environment_id",
7	"feature_id": "feature_id",
8	"id": "id",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"value_type": "value_type",
11	"company": {
12	"add_ons": [
13	{
14	"id": "id",
15	"name": "name"
16	}
17	],
18	"billing_subscriptions": [
19	{
20	"created_at": "2024-01-15T09:30:00Z",
21	"currency": "currency",
22	"customer_external_id": "customer_external_id",
23	"id": "id",
24	"interval": "interval",
25	"period_end": 1,
26	"period_start": 1,
27	"products": [
28	{
29	"created_at": "2024-01-15T09:30:00Z",
30	"currency": "currency",
31	"environment_id": "environment_id",
32	"external_id": "external_id",
33	"id": "id",
34	"interval": "interval",
35	"name": "name",
36	"price": 1,
37	"price_external_id": "price_external_id",
38	"quantity": 1.1,
39	"subscription_id": "subscription_id",
40	"updated_at": "2024-01-15T09:30:00Z",
41	"usage_type": "usage_type"
42	}
43	],
44	"status": "status",
45	"subscription_external_id": "subscription_external_id",
46	"total_price": 1
47	}
48	],
49	"created_at": "2024-01-15T09:30:00Z",
50	"entity_traits": [
51	{
52	"created_at": "2024-01-15T09:30:00Z",
53	"definition_id": "definition_id",
54	"environment_id": "environment_id",
55	"id": "id",
56	"updated_at": "2024-01-15T09:30:00Z",
57	"value": "value"
58	}
59	],
60	"environment_id": "environment_id",
61	"id": "id",
62	"keys": [
63	{
64	"created_at": "2024-01-15T09:30:00Z",
65	"definition_id": "definition_id",
66	"entity_id": "entity_id",
67	"entity_type": "entity_type",
68	"environment_id": "environment_id",
69	"id": "id",
70	"key": "key",
71	"updated_at": "2024-01-15T09:30:00Z",
72	"value": "value"
73	}
74	],
75	"name": "name",
76	"plans": [
77	{
78	"id": "id",
79	"name": "name"
80	}
81	],
82	"updated_at": "2024-01-15T09:30:00Z",
83	"user_count": 1
84	},
85	"expiration_date": "2024-01-15T09:30:00Z",
86	"feature": {
87	"created_at": "2024-01-15T09:30:00Z",
88	"description": "description",
89	"feature_type": "feature_type",
90	"icon": "icon",
91	"id": "id",
92	"name": "name",
93	"updated_at": "2024-01-15T09:30:00Z"
94	},
95	"metric_period": "metric_period",
96	"metric_period_month_reset": "metric_period_month_reset",
97	"rule_id": "rule_id",
98	"value_bool": true,
99	"value_numeric": 1,
100	"value_trait": {
101	"created_at": "2024-01-15T09:30:00Z",
102	"display_name": "display_name",
103	"entity_type": "entity_type",
104	"hierarchy": [
105	"hierarchy"
106	],
107	"id": "id",
108	"trait_type": "trait_type",
109	"updated_at": "2024-01-15T09:30:00Z"
110	},
111	"value_trait_id": "value_trait_id"
112	}
113	],
114	"params": {
115	"company_id": "company_id",
116	"company_ids": [
117	"company_ids"
118	],
119	"feature_id": "feature_id",
120	"feature_ids": [
121	"feature_ids"
122	],
123	"ids": [
124	"ids"
125	],
126	"limit": 1,
127	"offset": 1,
128	"q": "q"
129	}
130	}