List companies

GET

https://api.schematichq.com/companies

GET

/companies

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

Try it

1 {
2   "data": [
3     {
4       "add_ons": [
5         {
6           "id": "id",
7           "name": "name"
8         }
9       ],
10       "billing_subscriptions": [
11         {
12           "cancel_at_period_end": true,
13           "created_at": "2024-01-15T09:30:00Z",
14           "currency": "currency",
15           "customer_external_id": "customer_external_id",
16           "discounts": [
17             {
18               "coupon_id": "coupon_id",
19               "coupon_name": "coupon_name",
20               "discount_external_id": "discount_external_id",
21               "duration": "duration",
22               "is_active": true,
23               "started_at": "2024-01-15T09:30:00Z",
24               "subscription_external_id": "subscription_external_id"
25             }
26           ],
27           "id": "id",
28           "interval": "interval",
29           "period_end": 1,
30           "period_start": 1,
31           "products": [
32             {
33               "billing_scheme": "billing_scheme",
34               "created_at": "2024-01-15T09:30:00Z",
35               "currency": "currency",
36               "environment_id": "environment_id",
37               "external_id": "external_id",
38               "id": "id",
39               "interval": "interval",
40               "name": "name",
41               "package_size": 1,
42               "price": 1,
43               "price_external_id": "price_external_id",
44               "price_id": "price_id",
45               "price_tier": [
46                 {}
47               ],
48               "quantity": 1.1,
49               "subscription_id": "subscription_id",
50               "updated_at": "2024-01-15T09:30:00Z",
51               "usage_type": "usage_type"
52             }
53           ],
54           "status": "status",
55           "subscription_external_id": "subscription_external_id",
56           "total_price": 1
57         }
58       ],
59       "created_at": "2024-01-15T09:30:00Z",
60       "entity_traits": [
61         {
62           "created_at": "2024-01-15T09:30:00Z",
63           "definition_id": "definition_id",
64           "environment_id": "environment_id",
65           "id": "id",
66           "updated_at": "2024-01-15T09:30:00Z",
67           "value": "value"
68         }
69       ],
70       "environment_id": "environment_id",
71       "id": "id",
72       "keys": [
73         {
74           "created_at": "2024-01-15T09:30:00Z",
75           "definition_id": "definition_id",
76           "entity_id": "entity_id",
77           "entity_type": "entity_type",
78           "environment_id": "environment_id",
79           "id": "id",
80           "key": "key",
81           "updated_at": "2024-01-15T09:30:00Z",
82           "value": "value"
83         }
84       ],
85       "metrics": [
86         {
87           "account_id": "account_id",
88           "captured_at_max": "2024-01-15T09:30:00Z",
89           "captured_at_min": "2024-01-15T09:30:00Z",
90           "company_id": "company_id",
91           "created_at": "2024-01-15T09:30:00Z",
92           "environment_id": "environment_id",
93           "event_subtype": "event_subtype",
94           "month_reset": "month_reset",
95           "period": "period",
96           "value": 1
97         }
98       ],
99       "name": "name",
100       "payment_methods": [
101         {
102           "created_at": "2024-01-15T09:30:00Z",
103           "customer_external_id": "customer_external_id",
104           "environment_id": "environment_id",
105           "external_id": "external_id",
106           "id": "id",
107           "payment_method_type": "payment_method_type",
108           "updated_at": "2024-01-15T09:30:00Z"
109         }
110       ],
111       "plans": [
112         {
113           "id": "id",
114           "name": "name"
115         }
116       ],
117       "updated_at": "2024-01-15T09:30:00Z",
118       "user_count": 1,
119       "billing_subscription": {
120         "cancel_at_period_end": true,
121         "created_at": "2024-01-15T09:30:00Z",
122         "currency": "currency",
123         "customer_external_id": "customer_external_id",
124         "discounts": [
125           {
126             "coupon_id": "coupon_id",
127             "coupon_name": "coupon_name",
128             "discount_external_id": "discount_external_id",
129             "duration": "duration",
130             "is_active": true,
131             "started_at": "2024-01-15T09:30:00Z",
132             "subscription_external_id": "subscription_external_id"
133           }
134         ],
135         "id": "id",
136         "interval": "interval",
137         "period_end": 1,
138         "period_start": 1,
139         "products": [
140           {
141             "billing_scheme": "billing_scheme",
142             "created_at": "2024-01-15T09:30:00Z",
143             "currency": "currency",
144             "environment_id": "environment_id",
145             "external_id": "external_id",
146             "id": "id",
147             "interval": "interval",
148             "name": "name",
149             "package_size": 1,
150             "price": 1,
151             "price_external_id": "price_external_id",
152             "price_id": "price_id",
153             "price_tier": [
154               {}
155             ],
156             "quantity": 1.1,
157             "subscription_id": "subscription_id",
158             "updated_at": "2024-01-15T09:30:00Z",
159             "usage_type": "usage_type"
160           }
161         ],
162         "status": "status",
163         "subscription_external_id": "subscription_external_id",
164         "total_price": 1
165       },
166       "default_payment_method": {
167         "created_at": "2024-01-15T09:30:00Z",
168         "customer_external_id": "customer_external_id",
169         "environment_id": "environment_id",
170         "external_id": "external_id",
171         "id": "id",
172         "payment_method_type": "payment_method_type",
173         "updated_at": "2024-01-15T09:30:00Z"
174       },
175       "last_seen_at": "2024-01-15T09:30:00Z",
176       "logo_url": "logo_url",
177       "plan": {
178         "id": "id",
179         "name": "name"
180       },
181       "traits": {
182         "key": "value"
183       }
184     }
185   ],
186   "params": {
187     "ids": [
188       "ids"
189     ],
190     "limit": 1,
191     "offset": 1,
192     "plan_id": "plan_id",
193     "q": "q",
194     "with_subscription": true,
195     "without_feature_override_for": "without_feature_override_for",
196     "without_plan": true
197   }
198 }

Query parameters

idsstringOptional

Filter companies by multiple company IDs (starts with comp_)

plan_idstringOptional

Filter companies by plan ID (starts with plan_)

qstringOptional

Search for companies by name, keys or string traits

without_feature_override_forstringOptional

Filter out companies that already have a company override for the specified feature ID

without_planbooleanOptional

Filter out companies that have a plan

with_subscriptionbooleanOptional

Filter companies that have a subscription

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

The returned resources

paramsobject

Input parameters

List companies

Headers

Query parameters

Response

Errors