Lookup company

GET

1 import { SchematicClient, Schematic } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.companies.lookupCompany({
5     keys: {
6         "keys": {
7             "key": "value"
8         }
9     }
10 });

Try it

1 {
2   "data": {
3     "add_ons": [
4       {
5         "id": "id",
6         "name": "name",
7         "billing_product_id": "billing_product_id",
8         "description": "description",
9         "image_url": "image_url",
10         "plan_period": "plan_period",
11         "plan_price": 1
12       },
13       {
14         "id": "id",
15         "name": "name",
16         "billing_product_id": "billing_product_id",
17         "description": "description",
18         "image_url": "image_url",
19         "plan_period": "plan_period",
20         "plan_price": 1
21       }
22     ],
23     "billing_subscriptions": [
24       {
25         "cancel_at_period_end": true,
26         "created_at": "2024-01-15T09:30:00Z",
27         "currency": "currency",
28         "customer_external_id": "customer_external_id",
29         "discounts": [
30           {
31             "coupon_id": "coupon_id",
32             "coupon_name": "coupon_name",
33             "discount_external_id": "discount_external_id",
34             "duration": "duration",
35             "is_active": true,
36             "started_at": "2024-01-15T09:30:00Z",
37             "subscription_external_id": "subscription_external_id",
38             "amount_off": 1,
39             "currency": "currency",
40             "customer_facing_code": "customer_facing_code",
41             "duration_in_months": 1,
42             "ended_at": "2024-01-15T09:30:00Z",
43             "percent_off": 1.1,
44             "promo_code_external_id": "promo_code_external_id"
45           },
46           {
47             "coupon_id": "coupon_id",
48             "coupon_name": "coupon_name",
49             "discount_external_id": "discount_external_id",
50             "duration": "duration",
51             "is_active": true,
52             "started_at": "2024-01-15T09:30:00Z",
53             "subscription_external_id": "subscription_external_id",
54             "amount_off": 1,
55             "currency": "currency",
56             "customer_facing_code": "customer_facing_code",
57             "duration_in_months": 1,
58             "ended_at": "2024-01-15T09:30:00Z",
59             "percent_off": 1.1,
60             "promo_code_external_id": "promo_code_external_id"
61           }
62         ],
63         "id": "id",
64         "interval": "interval",
65         "period_end": 1,
66         "period_start": 1,
67         "products": [
68           {
69             "created_at": "2024-01-15T09:30:00Z",
70             "currency": "currency",
71             "environment_id": "environment_id",
72             "external_id": "external_id",
73             "id": "id",
74             "interval": "interval",
75             "name": "name",
76             "price": 1,
77             "price_external_id": "price_external_id",
78             "price_id": "price_id",
79             "quantity": 1.1,
80             "subscription_id": "subscription_id",
81             "updated_at": "2024-01-15T09:30:00Z",
82             "usage_type": "usage_type",
83             "meter_id": "meter_id"
84           },
85           {
86             "created_at": "2024-01-15T09:30:00Z",
87             "currency": "currency",
88             "environment_id": "environment_id",
89             "external_id": "external_id",
90             "id": "id",
91             "interval": "interval",
92             "name": "name",
93             "price": 1,
94             "price_external_id": "price_external_id",
95             "price_id": "price_id",
96             "quantity": 1.1,
97             "subscription_id": "subscription_id",
98             "updated_at": "2024-01-15T09:30:00Z",
99             "usage_type": "usage_type",
100             "meter_id": "meter_id"
101           }
102         ],
103         "status": "status",
104         "subscription_external_id": "subscription_external_id",
105         "total_price": 1,
106         "cancel_at": 1,
107         "company_id": "company_id",
108         "expired_at": "2024-01-15T09:30:00Z",
109         "latest_invoice": {
110           "amount_due": 1,
111           "amount_paid": 1,
112           "amount_remaining": 1,
113           "collection_method": "collection_method",
114           "created_at": "2024-01-15T09:30:00Z",
115           "currency": "currency",
116           "customer_external_id": "customer_external_id",
117           "environment_id": "environment_id",
118           "id": "id",
119           "subtotal": 1,
120           "updated_at": "2024-01-15T09:30:00Z",
121           "company_id": "company_id",
122           "due_date": "2024-01-15T09:30:00Z",
123           "external_id": "external_id",
124           "payment_method_external_id": "payment_method_external_id",
125           "subscription_external_id": "subscription_external_id",
126           "url": "url"
127         },
128         "metadata": {
129           "metadata": {
130             "key": "value"
131           }
132         },
133         "payment_method": {
134           "created_at": "2024-01-15T09:30:00Z",
135           "customer_external_id": "customer_external_id",
136           "environment_id": "environment_id",
137           "external_id": "external_id",
138           "id": "id",
139           "payment_method_type": "payment_method_type",
140           "updated_at": "2024-01-15T09:30:00Z",
141           "account_last4": "account_last4",
142           "account_name": "account_name",
143           "bank_name": "bank_name",
144           "billing_email": "billing_email",
145           "billing_name": "billing_name",
146           "card_brand": "card_brand",
147           "card_exp_month": 1,
148           "card_exp_year": 1,
149           "card_last4": "card_last4",
150           "company_id": "company_id",
151           "subscription_external_id": "subscription_external_id"
152         },
153         "trial_end": 1,
154         "trial_end_setting": "trial_end_setting"
155       },
156       {
157         "cancel_at_period_end": true,
158         "created_at": "2024-01-15T09:30:00Z",
159         "currency": "currency",
160         "customer_external_id": "customer_external_id",
161         "discounts": [
162           {
163             "coupon_id": "coupon_id",
164             "coupon_name": "coupon_name",
165             "discount_external_id": "discount_external_id",
166             "duration": "duration",
167             "is_active": true,
168             "started_at": "2024-01-15T09:30:00Z",
169             "subscription_external_id": "subscription_external_id",
170             "amount_off": 1,
171             "currency": "currency",
172             "customer_facing_code": "customer_facing_code",
173             "duration_in_months": 1,
174             "ended_at": "2024-01-15T09:30:00Z",
175             "percent_off": 1.1,
176             "promo_code_external_id": "promo_code_external_id"
177           },
178           {
179             "coupon_id": "coupon_id",
180             "coupon_name": "coupon_name",
181             "discount_external_id": "discount_external_id",
182             "duration": "duration",
183             "is_active": true,
184             "started_at": "2024-01-15T09:30:00Z",
185             "subscription_external_id": "subscription_external_id",
186             "amount_off": 1,
187             "currency": "currency",
188             "customer_facing_code": "customer_facing_code",
189             "duration_in_months": 1,
190             "ended_at": "2024-01-15T09:30:00Z",
191             "percent_off": 1.1,
192             "promo_code_external_id": "promo_code_external_id"
193           }
194         ],
195         "id": "id",
196         "interval": "interval",
197         "period_end": 1,
198         "period_start": 1,
199         "products": [
200           {
201             "created_at": "2024-01-15T09:30:00Z",
202             "currency": "currency",
203             "environment_id": "environment_id",
204             "external_id": "external_id",
205             "id": "id",
206             "interval": "interval",
207             "name": "name",
208             "price": 1,
209             "price_external_id": "price_external_id",
210             "price_id": "price_id",
211             "quantity": 1.1,
212             "subscription_id": "subscription_id",
213             "updated_at": "2024-01-15T09:30:00Z",
214             "usage_type": "usage_type",
215             "meter_id": "meter_id"
216           },
217           {
218             "created_at": "2024-01-15T09:30:00Z",
219             "currency": "currency",
220             "environment_id": "environment_id",
221             "external_id": "external_id",
222             "id": "id",
223             "interval": "interval",
224             "name": "name",
225             "price": 1,
226             "price_external_id": "price_external_id",
227             "price_id": "price_id",
228             "quantity": 1.1,
229             "subscription_id": "subscription_id",
230             "updated_at": "2024-01-15T09:30:00Z",
231             "usage_type": "usage_type",
232             "meter_id": "meter_id"
233           }
234         ],
235         "status": "status",
236         "subscription_external_id": "subscription_external_id",
237         "total_price": 1,
238         "cancel_at": 1,
239         "company_id": "company_id",
240         "expired_at": "2024-01-15T09:30:00Z",
241         "latest_invoice": {
242           "amount_due": 1,
243           "amount_paid": 1,
244           "amount_remaining": 1,
245           "collection_method": "collection_method",
246           "created_at": "2024-01-15T09:30:00Z",
247           "currency": "currency",
248           "customer_external_id": "customer_external_id",
249           "environment_id": "environment_id",
250           "id": "id",
251           "subtotal": 1,
252           "updated_at": "2024-01-15T09:30:00Z",
253           "company_id": "company_id",
254           "due_date": "2024-01-15T09:30:00Z",
255           "external_id": "external_id",
256           "payment_method_external_id": "payment_method_external_id",
257           "subscription_external_id": "subscription_external_id",
258           "url": "url"
259         },
260         "metadata": {
261           "metadata": {
262             "key": "value"
263           }
264         },
265         "payment_method": {
266           "created_at": "2024-01-15T09:30:00Z",
267           "customer_external_id": "customer_external_id",
268           "environment_id": "environment_id",
269           "external_id": "external_id",
270           "id": "id",
271           "payment_method_type": "payment_method_type",
272           "updated_at": "2024-01-15T09:30:00Z",
273           "account_last4": "account_last4",
274           "account_name": "account_name",
275           "bank_name": "bank_name",
276           "billing_email": "billing_email",
277           "billing_name": "billing_name",
278           "card_brand": "card_brand",
279           "card_exp_month": 1,
280           "card_exp_year": 1,
281           "card_last4": "card_last4",
282           "company_id": "company_id",
283           "subscription_external_id": "subscription_external_id"
284         },
285         "trial_end": 1,
286         "trial_end_setting": "trial_end_setting"
287       }
288     ],
289     "created_at": "2024-01-15T09:30:00Z",
290     "entity_traits": [
291       {
292         "created_at": "2024-01-15T09:30:00Z",
293         "definition_id": "definition_id",
294         "environment_id": "environment_id",
295         "id": "id",
296         "updated_at": "2024-01-15T09:30:00Z",
297         "value": "value",
298         "definition": {
299           "created_at": "2024-01-15T09:30:00Z",
300           "display_name": "display_name",
301           "entity_type": "entity_type",
302           "hierarchy": [
303             "hierarchy",
304             "hierarchy"
305           ],
306           "id": "id",
307           "trait_type": "trait_type",
308           "updated_at": "2024-01-15T09:30:00Z"
309         }
310       },
311       {
312         "created_at": "2024-01-15T09:30:00Z",
313         "definition_id": "definition_id",
314         "environment_id": "environment_id",
315         "id": "id",
316         "updated_at": "2024-01-15T09:30:00Z",
317         "value": "value",
318         "definition": {
319           "created_at": "2024-01-15T09:30:00Z",
320           "display_name": "display_name",
321           "entity_type": "entity_type",
322           "hierarchy": [
323             "hierarchy",
324             "hierarchy"
325           ],
326           "id": "id",
327           "trait_type": "trait_type",
328           "updated_at": "2024-01-15T09:30:00Z"
329         }
330       }
331     ],
332     "environment_id": "environment_id",
333     "id": "id",
334     "keys": [
335       {
336         "created_at": "2024-01-15T09:30:00Z",
337         "definition_id": "definition_id",
338         "entity_id": "entity_id",
339         "entity_type": "entity_type",
340         "environment_id": "environment_id",
341         "id": "id",
342         "key": "key",
343         "updated_at": "2024-01-15T09:30:00Z",
344         "value": "value",
345         "definition": {
346           "created_at": "2024-01-15T09:30:00Z",
347           "entity_type": "entity_type",
348           "id": "id",
349           "key": "key",
350           "updated_at": "2024-01-15T09:30:00Z"
351         }
352       },
353       {
354         "created_at": "2024-01-15T09:30:00Z",
355         "definition_id": "definition_id",
356         "entity_id": "entity_id",
357         "entity_type": "entity_type",
358         "environment_id": "environment_id",
359         "id": "id",
360         "key": "key",
361         "updated_at": "2024-01-15T09:30:00Z",
362         "value": "value",
363         "definition": {
364           "created_at": "2024-01-15T09:30:00Z",
365           "entity_type": "entity_type",
366           "id": "id",
367           "key": "key",
368           "updated_at": "2024-01-15T09:30:00Z"
369         }
370       }
371     ],
372     "metrics": [
373       {
374         "account_id": "account_id",
375         "captured_at_max": "2024-01-15T09:30:00Z",
376         "captured_at_min": "2024-01-15T09:30:00Z",
377         "company_id": "company_id",
378         "created_at": "2024-01-15T09:30:00Z",
379         "environment_id": "environment_id",
380         "event_subtype": "event_subtype",
381         "month_reset": "month_reset",
382         "period": "period",
383         "value": 1,
384         "valid_until": "2024-01-15T09:30:00Z"
385       },
386       {
387         "account_id": "account_id",
388         "captured_at_max": "2024-01-15T09:30:00Z",
389         "captured_at_min": "2024-01-15T09:30:00Z",
390         "company_id": "company_id",
391         "created_at": "2024-01-15T09:30:00Z",
392         "environment_id": "environment_id",
393         "event_subtype": "event_subtype",
394         "month_reset": "month_reset",
395         "period": "period",
396         "value": 1,
397         "valid_until": "2024-01-15T09:30:00Z"
398       }
399     ],
400     "name": "name",
401     "plans": [
402       {
403         "id": "id",
404         "name": "name",
405         "description": "description",
406         "image_url": "image_url"
407       },
408       {
409         "id": "id",
410         "name": "name",
411         "description": "description",
412         "image_url": "image_url"
413       }
414     ],
415     "updated_at": "2024-01-15T09:30:00Z",
416     "user_count": 1,
417     "billing_subscription": {
418       "cancel_at_period_end": true,
419       "created_at": "2024-01-15T09:30:00Z",
420       "currency": "currency",
421       "customer_external_id": "customer_external_id",
422       "discounts": [
423         {
424           "coupon_id": "coupon_id",
425           "coupon_name": "coupon_name",
426           "discount_external_id": "discount_external_id",
427           "duration": "duration",
428           "is_active": true,
429           "started_at": "2024-01-15T09:30:00Z",
430           "subscription_external_id": "subscription_external_id",
431           "amount_off": 1,
432           "currency": "currency",
433           "customer_facing_code": "customer_facing_code",
434           "duration_in_months": 1,
435           "ended_at": "2024-01-15T09:30:00Z",
436           "percent_off": 1.1,
437           "promo_code_external_id": "promo_code_external_id"
438         },
439         {
440           "coupon_id": "coupon_id",
441           "coupon_name": "coupon_name",
442           "discount_external_id": "discount_external_id",
443           "duration": "duration",
444           "is_active": true,
445           "started_at": "2024-01-15T09:30:00Z",
446           "subscription_external_id": "subscription_external_id",
447           "amount_off": 1,
448           "currency": "currency",
449           "customer_facing_code": "customer_facing_code",
450           "duration_in_months": 1,
451           "ended_at": "2024-01-15T09:30:00Z",
452           "percent_off": 1.1,
453           "promo_code_external_id": "promo_code_external_id"
454         }
455       ],
456       "id": "id",
457       "interval": "interval",
458       "period_end": 1,
459       "period_start": 1,
460       "products": [
461         {
462           "created_at": "2024-01-15T09:30:00Z",
463           "currency": "currency",
464           "environment_id": "environment_id",
465           "external_id": "external_id",
466           "id": "id",
467           "interval": "interval",
468           "name": "name",
469           "price": 1,
470           "price_external_id": "price_external_id",
471           "price_id": "price_id",
472           "quantity": 1.1,
473           "subscription_id": "subscription_id",
474           "updated_at": "2024-01-15T09:30:00Z",
475           "usage_type": "usage_type",
476           "meter_id": "meter_id"
477         },
478         {
479           "created_at": "2024-01-15T09:30:00Z",
480           "currency": "currency",
481           "environment_id": "environment_id",
482           "external_id": "external_id",
483           "id": "id",
484           "interval": "interval",
485           "name": "name",
486           "price": 1,
487           "price_external_id": "price_external_id",
488           "price_id": "price_id",
489           "quantity": 1.1,
490           "subscription_id": "subscription_id",
491           "updated_at": "2024-01-15T09:30:00Z",
492           "usage_type": "usage_type",
493           "meter_id": "meter_id"
494         }
495       ],
496       "status": "status",
497       "subscription_external_id": "subscription_external_id",
498       "total_price": 1,
499       "cancel_at": 1,
500       "company_id": "company_id",
501       "expired_at": "2024-01-15T09:30:00Z",
502       "latest_invoice": {
503         "amount_due": 1,
504         "amount_paid": 1,
505         "amount_remaining": 1,
506         "collection_method": "collection_method",
507         "created_at": "2024-01-15T09:30:00Z",
508         "currency": "currency",
509         "customer_external_id": "customer_external_id",
510         "environment_id": "environment_id",
511         "id": "id",
512         "subtotal": 1,
513         "updated_at": "2024-01-15T09:30:00Z",
514         "company_id": "company_id",
515         "due_date": "2024-01-15T09:30:00Z",
516         "external_id": "external_id",
517         "payment_method_external_id": "payment_method_external_id",
518         "subscription_external_id": "subscription_external_id",
519         "url": "url"
520       },
521       "metadata": {
522         "metadata": {
523           "key": "value"
524         }
525       },
526       "payment_method": {
527         "created_at": "2024-01-15T09:30:00Z",
528         "customer_external_id": "customer_external_id",
529         "environment_id": "environment_id",
530         "external_id": "external_id",
531         "id": "id",
532         "payment_method_type": "payment_method_type",
533         "updated_at": "2024-01-15T09:30:00Z",
534         "account_last4": "account_last4",
535         "account_name": "account_name",
536         "bank_name": "bank_name",
537         "billing_email": "billing_email",
538         "billing_name": "billing_name",
539         "card_brand": "card_brand",
540         "card_exp_month": 1,
541         "card_exp_year": 1,
542         "card_last4": "card_last4",
543         "company_id": "company_id",
544         "subscription_external_id": "subscription_external_id"
545       },
546       "trial_end": 1,
547       "trial_end_setting": "trial_end_setting"
548     },
549     "last_seen_at": "2024-01-15T09:30:00Z",
550     "logo_url": "logo_url",
551     "plan": {
552       "id": "id",
553       "name": "name",
554       "billing_product_id": "billing_product_id",
555       "description": "description",
556       "image_url": "image_url",
557       "plan_period": "plan_period",
558       "plan_price": 1
559     },
560     "traits": {
561       "traits": {
562         "key": "value"
563       }
564     }
565   },
566   "params": {
567     "keys": {
568       "keys": {
569         "key": "value"
570       }
571     }
572   }
573 }

Query parameters

keysmap from strings to anyRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Lookup company

Headers

Query parameters

Response

Errors