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             "discounts": [
24               {
25                 "coupon_id": "coupon_id",
26                 "coupon_name": "coupon_name",
27                 "discount_external_id": "discount_external_id",
28                 "duration": "duration",
29                 "is_active": true,
30                 "started_at": "2024-01-15T09:30:00Z",
31                 "subscription_external_id": "subscription_external_id"
32               }
33             ],
34             "id": "id",
35             "interval": "interval",
36             "period_end": 1,
37             "period_start": 1,
38             "products": [
39               {
40                 "created_at": "2024-01-15T09:30:00Z",
41                 "currency": "currency",
42                 "environment_id": "environment_id",
43                 "external_id": "external_id",
44                 "id": "id",
45                 "interval": "interval",
46                 "name": "name",
47                 "price": 1,
48                 "price_external_id": "price_external_id",
49                 "price_id": "price_id",
50                 "quantity": 1.1,
51                 "subscription_id": "subscription_id",
52                 "updated_at": "2024-01-15T09:30:00Z",
53                 "usage_type": "usage_type"
54               }
55             ],
56             "status": "status",
57             "subscription_external_id": "subscription_external_id",
58             "total_price": 1
59           }
60         ],
61         "created_at": "2024-01-15T09:30:00Z",
62         "entity_traits": [
63           {
64             "created_at": "2024-01-15T09:30:00Z",
65             "definition_id": "definition_id",
66             "environment_id": "environment_id",
67             "id": "id",
68             "updated_at": "2024-01-15T09:30:00Z",
69             "value": "value"
70           }
71         ],
72         "environment_id": "environment_id",
73         "id": "id",
74         "keys": [
75           {
76             "created_at": "2024-01-15T09:30:00Z",
77             "definition_id": "definition_id",
78             "entity_id": "entity_id",
79             "entity_type": "entity_type",
80             "environment_id": "environment_id",
81             "id": "id",
82             "key": "key",
83             "updated_at": "2024-01-15T09:30:00Z",
84             "value": "value"
85           }
86         ],
87         "name": "name",
88         "plans": [
89           {
90             "id": "id",
91             "name": "name"
92           }
93         ],
94         "updated_at": "2024-01-15T09:30:00Z",
95         "user_count": 1
96       },
97       "expiration_date": "2024-01-15T09:30:00Z",
98       "feature": {
99         "created_at": "2024-01-15T09:30:00Z",
100         "description": "description",
101         "feature_type": "feature_type",
102         "icon": "icon",
103         "id": "id",
104         "name": "name",
105         "updated_at": "2024-01-15T09:30:00Z"
106       },
107       "metric_period": "metric_period",
108       "metric_period_month_reset": "metric_period_month_reset",
109       "rule_id": "rule_id",
110       "value_bool": true,
111       "value_numeric": 1,
112       "value_trait": {
113         "created_at": "2024-01-15T09:30:00Z",
114         "display_name": "display_name",
115         "entity_type": "entity_type",
116         "hierarchy": [
117           "hierarchy"
118         ],
119         "id": "id",
120         "trait_type": "trait_type",
121         "updated_at": "2024-01-15T09:30:00Z"
122       },
123       "value_trait_id": "value_trait_id"
124     }
125   ],
126   "params": {
127     "company_id": "company_id",
128     "company_ids": [
129       "company_ids"
130     ],
131     "feature_id": "feature_id",
132     "feature_ids": [
133       "feature_ids"
134     ],
135     "ids": [
136       "ids"
137     ],
138     "limit": 1,
139     "offset": 1,
140     "q": "q"
141   }
142 }

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	"discounts": [
24	{
25	"coupon_id": "coupon_id",
26	"coupon_name": "coupon_name",
27	"discount_external_id": "discount_external_id",
28	"duration": "duration",
29	"is_active": true,
30	"started_at": "2024-01-15T09:30:00Z",
31	"subscription_external_id": "subscription_external_id"
32	}
33	],
34	"id": "id",
35	"interval": "interval",
36	"period_end": 1,
37	"period_start": 1,
38	"products": [
39	{
40	"created_at": "2024-01-15T09:30:00Z",
41	"currency": "currency",
42	"environment_id": "environment_id",
43	"external_id": "external_id",
44	"id": "id",
45	"interval": "interval",
46	"name": "name",
47	"price": 1,
48	"price_external_id": "price_external_id",
49	"price_id": "price_id",
50	"quantity": 1.1,
51	"subscription_id": "subscription_id",
52	"updated_at": "2024-01-15T09:30:00Z",
53	"usage_type": "usage_type"
54	}
55	],
56	"status": "status",
57	"subscription_external_id": "subscription_external_id",
58	"total_price": 1
59	}
60	],
61	"created_at": "2024-01-15T09:30:00Z",
62	"entity_traits": [
63	{
64	"created_at": "2024-01-15T09:30:00Z",
65	"definition_id": "definition_id",
66	"environment_id": "environment_id",
67	"id": "id",
68	"updated_at": "2024-01-15T09:30:00Z",
69	"value": "value"
70	}
71	],
72	"environment_id": "environment_id",
73	"id": "id",
74	"keys": [
75	{
76	"created_at": "2024-01-15T09:30:00Z",
77	"definition_id": "definition_id",
78	"entity_id": "entity_id",
79	"entity_type": "entity_type",
80	"environment_id": "environment_id",
81	"id": "id",
82	"key": "key",
83	"updated_at": "2024-01-15T09:30:00Z",
84	"value": "value"
85	}
86	],
87	"name": "name",
88	"plans": [
89	{
90	"id": "id",
91	"name": "name"
92	}
93	],
94	"updated_at": "2024-01-15T09:30:00Z",
95	"user_count": 1
96	},
97	"expiration_date": "2024-01-15T09:30:00Z",
98	"feature": {
99	"created_at": "2024-01-15T09:30:00Z",
100	"description": "description",
101	"feature_type": "feature_type",
102	"icon": "icon",
103	"id": "id",
104	"name": "name",
105	"updated_at": "2024-01-15T09:30:00Z"
106	},
107	"metric_period": "metric_period",
108	"metric_period_month_reset": "metric_period_month_reset",
109	"rule_id": "rule_id",
110	"value_bool": true,
111	"value_numeric": 1,
112	"value_trait": {
113	"created_at": "2024-01-15T09:30:00Z",
114	"display_name": "display_name",
115	"entity_type": "entity_type",
116	"hierarchy": [
117	"hierarchy"
118	],
119	"id": "id",
120	"trait_type": "trait_type",
121	"updated_at": "2024-01-15T09:30:00Z"
122	},
123	"value_trait_id": "value_trait_id"
124	}
125	],
126	"params": {
127	"company_id": "company_id",
128	"company_ids": [
129	"company_ids"
130	],
131	"feature_id": "feature_id",
132	"feature_ids": [
133	"feature_ids"
134	],
135	"ids": [
136	"ids"
137	],
138	"limit": 1,
139	"offset": 1,
140	"q": "q"
141	}
142	}