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_)

without_expiredbooleanOptional

Filter company overrides by whether they have not expired

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 import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.entitlements.listCompanyOverrides();

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         "metrics": [
88           {
89             "account_id": "account_id",
90             "captured_at_max": "2024-01-15T09:30:00Z",
91             "captured_at_min": "2024-01-15T09:30:00Z",
92             "company_id": "company_id",
93             "created_at": "2024-01-15T09:30:00Z",
94             "environment_id": "environment_id",
95             "event_subtype": "event_subtype",
96             "month_reset": "month_reset",
97             "period": "period",
98             "value": 1
99           }
100         ],
101         "name": "name",
102         "plans": [
103           {
104             "id": "id",
105             "name": "name"
106           }
107         ],
108         "updated_at": "2024-01-15T09:30:00Z",
109         "user_count": 1
110       },
111       "expiration_date": "2024-01-15T09:30:00Z",
112       "feature": {
113         "created_at": "2024-01-15T09:30:00Z",
114         "description": "description",
115         "feature_type": "feature_type",
116         "icon": "icon",
117         "id": "id",
118         "name": "name",
119         "updated_at": "2024-01-15T09:30:00Z"
120       },
121       "metric_period": "metric_period",
122       "metric_period_month_reset": "metric_period_month_reset",
123       "rule_id": "rule_id",
124       "rule_id_usage_exceeded": "rule_id_usage_exceeded",
125       "value_bool": true,
126       "value_numeric": 1,
127       "value_trait": {
128         "created_at": "2024-01-15T09:30:00Z",
129         "display_name": "display_name",
130         "entity_type": "entity_type",
131         "hierarchy": [
132           "hierarchy"
133         ],
134         "id": "id",
135         "trait_type": "trait_type",
136         "updated_at": "2024-01-15T09:30:00Z"
137       },
138       "value_trait_id": "value_trait_id"
139     }
140   ],
141   "params": {
142     "company_id": "company_id",
143     "company_ids": [
144       "company_ids"
145     ],
146     "feature_id": "feature_id",
147     "feature_ids": [
148       "feature_ids"
149     ],
150     "ids": [
151       "ids"
152     ],
153     "limit": 1,
154     "offset": 1,
155     "q": "q",
156     "without_expired": true
157   }
158 }

Built with

1	import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2
3	const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4	await client.entitlements.listCompanyOverrides();

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	"metrics": [
88	{
89	"account_id": "account_id",
90	"captured_at_max": "2024-01-15T09:30:00Z",
91	"captured_at_min": "2024-01-15T09:30:00Z",
92	"company_id": "company_id",
93	"created_at": "2024-01-15T09:30:00Z",
94	"environment_id": "environment_id",
95	"event_subtype": "event_subtype",
96	"month_reset": "month_reset",
97	"period": "period",
98	"value": 1
99	}
100	],
101	"name": "name",
102	"plans": [
103	{
104	"id": "id",
105	"name": "name"
106	}
107	],
108	"updated_at": "2024-01-15T09:30:00Z",
109	"user_count": 1
110	},
111	"expiration_date": "2024-01-15T09:30:00Z",
112	"feature": {
113	"created_at": "2024-01-15T09:30:00Z",
114	"description": "description",
115	"feature_type": "feature_type",
116	"icon": "icon",
117	"id": "id",
118	"name": "name",
119	"updated_at": "2024-01-15T09:30:00Z"
120	},
121	"metric_period": "metric_period",
122	"metric_period_month_reset": "metric_period_month_reset",
123	"rule_id": "rule_id",
124	"rule_id_usage_exceeded": "rule_id_usage_exceeded",
125	"value_bool": true,
126	"value_numeric": 1,
127	"value_trait": {
128	"created_at": "2024-01-15T09:30:00Z",
129	"display_name": "display_name",
130	"entity_type": "entity_type",
131	"hierarchy": [
132	"hierarchy"
133	],
134	"id": "id",
135	"trait_type": "trait_type",
136	"updated_at": "2024-01-15T09:30:00Z"
137	},
138	"value_trait_id": "value_trait_id"
139	}
140	],
141	"params": {
142	"company_id": "company_id",
143	"company_ids": [
144	"company_ids"
145	],
146	"feature_id": "feature_id",
147	"feature_ids": [
148	"feature_ids"
149	],
150	"ids": [
151	"ids"
152	],
153	"limit": 1,
154	"offset": 1,
155	"q": "q",
156	"without_expired": true
157	}
158	}