List company overrides

GET

https://api.schematichq.com/company-overrides

GET

/company-overrides

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

Try it

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             "cancel_at_period_end": true,
21             "created_at": "2024-01-15T09:30:00Z",
22             "currency": "currency",
23             "customer_external_id": "customer_external_id",
24             "discounts": [
25               {
26                 "coupon_id": "coupon_id",
27                 "coupon_name": "coupon_name",
28                 "discount_external_id": "discount_external_id",
29                 "duration": "duration",
30                 "is_active": true,
31                 "started_at": "2024-01-15T09:30:00Z",
32                 "subscription_external_id": "subscription_external_id"
33               }
34             ],
35             "id": "id",
36             "interval": "interval",
37             "period_end": 1,
38             "period_start": 1,
39             "products": [
40               {
41                 "billing_scheme": "billing_scheme",
42                 "created_at": "2024-01-15T09:30:00Z",
43                 "currency": "currency",
44                 "environment_id": "environment_id",
45                 "external_id": "external_id",
46                 "id": "id",
47                 "interval": "interval",
48                 "name": "name",
49                 "package_size": 1,
50                 "price": 1,
51                 "price_external_id": "price_external_id",
52                 "price_id": "price_id",
53                 "price_tier": [
54                   {}
55                 ],
56                 "quantity": 1.1,
57                 "subscription_id": "subscription_id",
58                 "updated_at": "2024-01-15T09:30:00Z",
59                 "usage_type": "usage_type"
60               }
61             ],
62             "status": "status",
63             "subscription_external_id": "subscription_external_id",
64             "total_price": 1
65           }
66         ],
67         "created_at": "2024-01-15T09:30:00Z",
68         "entity_traits": [
69           {
70             "created_at": "2024-01-15T09:30:00Z",
71             "definition_id": "definition_id",
72             "environment_id": "environment_id",
73             "id": "id",
74             "updated_at": "2024-01-15T09:30:00Z",
75             "value": "value"
76           }
77         ],
78         "environment_id": "environment_id",
79         "id": "id",
80         "keys": [
81           {
82             "created_at": "2024-01-15T09:30:00Z",
83             "definition_id": "definition_id",
84             "entity_id": "entity_id",
85             "entity_type": "entity_type",
86             "environment_id": "environment_id",
87             "id": "id",
88             "key": "key",
89             "updated_at": "2024-01-15T09:30:00Z",
90             "value": "value"
91           }
92         ],
93         "metrics": [
94           {
95             "account_id": "account_id",
96             "captured_at_max": "2024-01-15T09:30:00Z",
97             "captured_at_min": "2024-01-15T09:30:00Z",
98             "company_id": "company_id",
99             "created_at": "2024-01-15T09:30:00Z",
100             "environment_id": "environment_id",
101             "event_subtype": "event_subtype",
102             "month_reset": "month_reset",
103             "period": "period",
104             "value": 1
105           }
106         ],
107         "name": "name",
108         "payment_methods": [
109           {
110             "created_at": "2024-01-15T09:30:00Z",
111             "customer_external_id": "customer_external_id",
112             "environment_id": "environment_id",
113             "external_id": "external_id",
114             "id": "id",
115             "payment_method_type": "payment_method_type",
116             "updated_at": "2024-01-15T09:30:00Z"
117           }
118         ],
119         "plans": [
120           {
121             "id": "id",
122             "name": "name"
123           }
124         ],
125         "updated_at": "2024-01-15T09:30:00Z",
126         "user_count": 1
127       },
128       "expiration_date": "2024-01-15T09:30:00Z",
129       "feature": {
130         "created_at": "2024-01-15T09:30:00Z",
131         "description": "description",
132         "feature_type": "feature_type",
133         "icon": "icon",
134         "id": "id",
135         "name": "name",
136         "updated_at": "2024-01-15T09:30:00Z"
137       },
138       "metric_period": "metric_period",
139       "metric_period_month_reset": "metric_period_month_reset",
140       "rule_id": "rule_id",
141       "rule_id_usage_exceeded": "rule_id_usage_exceeded",
142       "value_bool": true,
143       "value_numeric": 1,
144       "value_trait": {
145         "created_at": "2024-01-15T09:30:00Z",
146         "display_name": "display_name",
147         "entity_type": "entity_type",
148         "hierarchy": [
149           "hierarchy"
150         ],
151         "id": "id",
152         "trait_type": "trait_type",
153         "updated_at": "2024-01-15T09:30:00Z"
154       },
155       "value_trait_id": "value_trait_id"
156     }
157   ],
158   "params": {
159     "company_id": "company_id",
160     "company_ids": [
161       "company_ids"
162     ],
163     "feature_id": "feature_id",
164     "feature_ids": [
165       "feature_ids"
166     ],
167     "ids": [
168       "ids"
169     ],
170     "limit": 1,
171     "offset": 1,
172     "q": "q",
173     "without_expired": true
174   }
175 }

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

List company overrides

Headers

Query parameters

Response

Errors