Lookup company

GET

https://api.schematichq.com/companies/lookup

GET

/companies/lookup

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

Try it

1 {
2   "data": {
3     "add_ons": [
4       {
5         "id": "id",
6         "name": "name",
7         "added_on": "2024-01-15T09:30:00Z",
8         "billing_product_external_id": "billing_product_external_id",
9         "billing_product_id": "billing_product_id",
10         "description": "description",
11         "image_url": "image_url",
12         "plan_period": "plan_period",
13         "plan_price": 1
14       },
15       {
16         "id": "id",
17         "name": "name",
18         "added_on": "2024-01-15T09:30:00Z",
19         "billing_product_external_id": "billing_product_external_id",
20         "billing_product_id": "billing_product_id",
21         "description": "description",
22         "image_url": "image_url",
23         "plan_period": "plan_period",
24         "plan_price": 1
25       }
26     ],
27     "billing_subscriptions": [
28       {
29         "cancel_at_period_end": true,
30         "created_at": "2024-01-15T09:30:00Z",
31         "currency": "currency",
32         "customer_external_id": "customer_external_id",
33         "discounts": [
34           {
35             "coupon_id": "coupon_id",
36             "coupon_name": "coupon_name",
37             "discount_external_id": "discount_external_id",
38             "duration": "duration",
39             "is_active": true,
40             "started_at": "2024-01-15T09:30:00Z",
41             "subscription_external_id": "subscription_external_id",
42             "amount_off": 1,
43             "currency": "currency",
44             "customer_facing_code": "customer_facing_code",
45             "duration_in_months": 1,
46             "ended_at": "2024-01-15T09:30:00Z",
47             "percent_off": 1.1,
48             "promo_code_external_id": "promo_code_external_id"
49           },
50           {
51             "coupon_id": "coupon_id",
52             "coupon_name": "coupon_name",
53             "discount_external_id": "discount_external_id",
54             "duration": "duration",
55             "is_active": true,
56             "started_at": "2024-01-15T09:30:00Z",
57             "subscription_external_id": "subscription_external_id",
58             "amount_off": 1,
59             "currency": "currency",
60             "customer_facing_code": "customer_facing_code",
61             "duration_in_months": 1,
62             "ended_at": "2024-01-15T09:30:00Z",
63             "percent_off": 1.1,
64             "promo_code_external_id": "promo_code_external_id"
65           }
66         ],
67         "id": "id",
68         "interval": "interval",
69         "period_end": 1,
70         "period_start": 1,
71         "products": [
72           {
73             "billing_scheme": "billing_scheme",
74             "created_at": "2024-01-15T09:30:00Z",
75             "currency": "currency",
76             "environment_id": "environment_id",
77             "external_id": "external_id",
78             "id": "id",
79             "interval": "interval",
80             "name": "name",
81             "package_size": 1,
82             "price": 1,
83             "price_external_id": "price_external_id",
84             "price_id": "price_id",
85             "price_tier": [
86               {
87                 "flat_amount": 1,
88                 "per_unit_price": 1,
89                 "per_unit_price_decimal": "per_unit_price_decimal",
90                 "up_to": 1
91               },
92               {
93                 "flat_amount": 1,
94                 "per_unit_price": 1,
95                 "per_unit_price_decimal": "per_unit_price_decimal",
96                 "up_to": 1
97               }
98             ],
99             "quantity": 1.1,
100             "subscription_id": "subscription_id",
101             "updated_at": "2024-01-15T09:30:00Z",
102             "usage_type": "usage_type",
103             "meter_id": "meter_id",
104             "price_decimal": "price_decimal"
105           },
106           {
107             "billing_scheme": "billing_scheme",
108             "created_at": "2024-01-15T09:30:00Z",
109             "currency": "currency",
110             "environment_id": "environment_id",
111             "external_id": "external_id",
112             "id": "id",
113             "interval": "interval",
114             "name": "name",
115             "package_size": 1,
116             "price": 1,
117             "price_external_id": "price_external_id",
118             "price_id": "price_id",
119             "price_tier": [
120               {
121                 "flat_amount": 1,
122                 "per_unit_price": 1,
123                 "per_unit_price_decimal": "per_unit_price_decimal",
124                 "up_to": 1
125               },
126               {
127                 "flat_amount": 1,
128                 "per_unit_price": 1,
129                 "per_unit_price_decimal": "per_unit_price_decimal",
130                 "up_to": 1
131               }
132             ],
133             "quantity": 1.1,
134             "subscription_id": "subscription_id",
135             "updated_at": "2024-01-15T09:30:00Z",
136             "usage_type": "usage_type",
137             "meter_id": "meter_id",
138             "price_decimal": "price_decimal"
139           }
140         ],
141         "status": "status",
142         "subscription_external_id": "subscription_external_id",
143         "total_price": 1,
144         "cancel_at": 1,
145         "company_id": "company_id",
146         "default_payment_method_id": "default_payment_method_id",
147         "expired_at": "2024-01-15T09:30:00Z",
148         "latest_invoice": {
149           "amount_due": 1,
150           "amount_paid": 1,
151           "amount_remaining": 1,
152           "collection_method": "collection_method",
153           "created_at": "2024-01-15T09:30:00Z",
154           "currency": "currency",
155           "customer_external_id": "customer_external_id",
156           "environment_id": "environment_id",
157           "id": "id",
158           "subtotal": 1,
159           "updated_at": "2024-01-15T09:30:00Z",
160           "company_id": "company_id",
161           "due_date": "2024-01-15T09:30:00Z",
162           "external_id": "external_id",
163           "payment_method_external_id": "payment_method_external_id",
164           "subscription_external_id": "subscription_external_id",
165           "url": "url"
166         },
167         "metadata": {
168           "metadata": {
169             "key": "value"
170           }
171         },
172         "payment_method": {
173           "created_at": "2024-01-15T09:30:00Z",
174           "customer_external_id": "customer_external_id",
175           "environment_id": "environment_id",
176           "external_id": "external_id",
177           "id": "id",
178           "payment_method_type": "payment_method_type",
179           "updated_at": "2024-01-15T09:30:00Z",
180           "account_last4": "account_last4",
181           "account_name": "account_name",
182           "bank_name": "bank_name",
183           "billing_email": "billing_email",
184           "billing_name": "billing_name",
185           "card_brand": "card_brand",
186           "card_exp_month": 1,
187           "card_exp_year": 1,
188           "card_last4": "card_last4",
189           "company_id": "company_id"
190         },
191         "trial_end": 1,
192         "trial_end_setting": "trial_end_setting"
193       },
194       {
195         "cancel_at_period_end": true,
196         "created_at": "2024-01-15T09:30:00Z",
197         "currency": "currency",
198         "customer_external_id": "customer_external_id",
199         "discounts": [
200           {
201             "coupon_id": "coupon_id",
202             "coupon_name": "coupon_name",
203             "discount_external_id": "discount_external_id",
204             "duration": "duration",
205             "is_active": true,
206             "started_at": "2024-01-15T09:30:00Z",
207             "subscription_external_id": "subscription_external_id",
208             "amount_off": 1,
209             "currency": "currency",
210             "customer_facing_code": "customer_facing_code",
211             "duration_in_months": 1,
212             "ended_at": "2024-01-15T09:30:00Z",
213             "percent_off": 1.1,
214             "promo_code_external_id": "promo_code_external_id"
215           },
216           {
217             "coupon_id": "coupon_id",
218             "coupon_name": "coupon_name",
219             "discount_external_id": "discount_external_id",
220             "duration": "duration",
221             "is_active": true,
222             "started_at": "2024-01-15T09:30:00Z",
223             "subscription_external_id": "subscription_external_id",
224             "amount_off": 1,
225             "currency": "currency",
226             "customer_facing_code": "customer_facing_code",
227             "duration_in_months": 1,
228             "ended_at": "2024-01-15T09:30:00Z",
229             "percent_off": 1.1,
230             "promo_code_external_id": "promo_code_external_id"
231           }
232         ],
233         "id": "id",
234         "interval": "interval",
235         "period_end": 1,
236         "period_start": 1,
237         "products": [
238           {
239             "billing_scheme": "billing_scheme",
240             "created_at": "2024-01-15T09:30:00Z",
241             "currency": "currency",
242             "environment_id": "environment_id",
243             "external_id": "external_id",
244             "id": "id",
245             "interval": "interval",
246             "name": "name",
247             "package_size": 1,
248             "price": 1,
249             "price_external_id": "price_external_id",
250             "price_id": "price_id",
251             "price_tier": [
252               {
253                 "flat_amount": 1,
254                 "per_unit_price": 1,
255                 "per_unit_price_decimal": "per_unit_price_decimal",
256                 "up_to": 1
257               },
258               {
259                 "flat_amount": 1,
260                 "per_unit_price": 1,
261                 "per_unit_price_decimal": "per_unit_price_decimal",
262                 "up_to": 1
263               }
264             ],
265             "quantity": 1.1,
266             "subscription_id": "subscription_id",
267             "updated_at": "2024-01-15T09:30:00Z",
268             "usage_type": "usage_type",
269             "meter_id": "meter_id",
270             "price_decimal": "price_decimal"
271           },
272           {
273             "billing_scheme": "billing_scheme",
274             "created_at": "2024-01-15T09:30:00Z",
275             "currency": "currency",
276             "environment_id": "environment_id",
277             "external_id": "external_id",
278             "id": "id",
279             "interval": "interval",
280             "name": "name",
281             "package_size": 1,
282             "price": 1,
283             "price_external_id": "price_external_id",
284             "price_id": "price_id",
285             "price_tier": [
286               {
287                 "flat_amount": 1,
288                 "per_unit_price": 1,
289                 "per_unit_price_decimal": "per_unit_price_decimal",
290                 "up_to": 1
291               },
292               {
293                 "flat_amount": 1,
294                 "per_unit_price": 1,
295                 "per_unit_price_decimal": "per_unit_price_decimal",
296                 "up_to": 1
297               }
298             ],
299             "quantity": 1.1,
300             "subscription_id": "subscription_id",
301             "updated_at": "2024-01-15T09:30:00Z",
302             "usage_type": "usage_type",
303             "meter_id": "meter_id",
304             "price_decimal": "price_decimal"
305           }
306         ],
307         "status": "status",
308         "subscription_external_id": "subscription_external_id",
309         "total_price": 1,
310         "cancel_at": 1,
311         "company_id": "company_id",
312         "default_payment_method_id": "default_payment_method_id",
313         "expired_at": "2024-01-15T09:30:00Z",
314         "latest_invoice": {
315           "amount_due": 1,
316           "amount_paid": 1,
317           "amount_remaining": 1,
318           "collection_method": "collection_method",
319           "created_at": "2024-01-15T09:30:00Z",
320           "currency": "currency",
321           "customer_external_id": "customer_external_id",
322           "environment_id": "environment_id",
323           "id": "id",
324           "subtotal": 1,
325           "updated_at": "2024-01-15T09:30:00Z",
326           "company_id": "company_id",
327           "due_date": "2024-01-15T09:30:00Z",
328           "external_id": "external_id",
329           "payment_method_external_id": "payment_method_external_id",
330           "subscription_external_id": "subscription_external_id",
331           "url": "url"
332         },
333         "metadata": {
334           "metadata": {
335             "key": "value"
336           }
337         },
338         "payment_method": {
339           "created_at": "2024-01-15T09:30:00Z",
340           "customer_external_id": "customer_external_id",
341           "environment_id": "environment_id",
342           "external_id": "external_id",
343           "id": "id",
344           "payment_method_type": "payment_method_type",
345           "updated_at": "2024-01-15T09:30:00Z",
346           "account_last4": "account_last4",
347           "account_name": "account_name",
348           "bank_name": "bank_name",
349           "billing_email": "billing_email",
350           "billing_name": "billing_name",
351           "card_brand": "card_brand",
352           "card_exp_month": 1,
353           "card_exp_year": 1,
354           "card_last4": "card_last4",
355           "company_id": "company_id"
356         },
357         "trial_end": 1,
358         "trial_end_setting": "trial_end_setting"
359       }
360     ],
361     "created_at": "2024-01-15T09:30:00Z",
362     "entity_traits": [
363       {
364         "created_at": "2024-01-15T09:30:00Z",
365         "definition_id": "definition_id",
366         "environment_id": "environment_id",
367         "id": "id",
368         "updated_at": "2024-01-15T09:30:00Z",
369         "value": "value",
370         "definition": {
371           "created_at": "2024-01-15T09:30:00Z",
372           "display_name": "display_name",
373           "entity_type": "entity_type",
374           "hierarchy": [
375             "hierarchy",
376             "hierarchy"
377           ],
378           "id": "id",
379           "trait_type": "trait_type",
380           "updated_at": "2024-01-15T09:30:00Z"
381         }
382       },
383       {
384         "created_at": "2024-01-15T09:30:00Z",
385         "definition_id": "definition_id",
386         "environment_id": "environment_id",
387         "id": "id",
388         "updated_at": "2024-01-15T09:30:00Z",
389         "value": "value",
390         "definition": {
391           "created_at": "2024-01-15T09:30:00Z",
392           "display_name": "display_name",
393           "entity_type": "entity_type",
394           "hierarchy": [
395             "hierarchy",
396             "hierarchy"
397           ],
398           "id": "id",
399           "trait_type": "trait_type",
400           "updated_at": "2024-01-15T09:30:00Z"
401         }
402       }
403     ],
404     "environment_id": "environment_id",
405     "id": "id",
406     "keys": [
407       {
408         "created_at": "2024-01-15T09:30:00Z",
409         "definition_id": "definition_id",
410         "entity_id": "entity_id",
411         "entity_type": "entity_type",
412         "environment_id": "environment_id",
413         "id": "id",
414         "key": "key",
415         "updated_at": "2024-01-15T09:30:00Z",
416         "value": "value",
417         "definition": {
418           "created_at": "2024-01-15T09:30:00Z",
419           "entity_type": "entity_type",
420           "id": "id",
421           "key": "key",
422           "updated_at": "2024-01-15T09:30:00Z"
423         }
424       },
425       {
426         "created_at": "2024-01-15T09:30:00Z",
427         "definition_id": "definition_id",
428         "entity_id": "entity_id",
429         "entity_type": "entity_type",
430         "environment_id": "environment_id",
431         "id": "id",
432         "key": "key",
433         "updated_at": "2024-01-15T09:30:00Z",
434         "value": "value",
435         "definition": {
436           "created_at": "2024-01-15T09:30:00Z",
437           "entity_type": "entity_type",
438           "id": "id",
439           "key": "key",
440           "updated_at": "2024-01-15T09:30:00Z"
441         }
442       }
443     ],
444     "metrics": [
445       {
446         "account_id": "account_id",
447         "captured_at_max": "2024-01-15T09:30:00Z",
448         "captured_at_min": "2024-01-15T09:30:00Z",
449         "company_id": "company_id",
450         "created_at": "2024-01-15T09:30:00Z",
451         "environment_id": "environment_id",
452         "event_subtype": "event_subtype",
453         "month_reset": "month_reset",
454         "period": "period",
455         "value": 1,
456         "valid_until": "2024-01-15T09:30:00Z"
457       },
458       {
459         "account_id": "account_id",
460         "captured_at_max": "2024-01-15T09:30:00Z",
461         "captured_at_min": "2024-01-15T09:30:00Z",
462         "company_id": "company_id",
463         "created_at": "2024-01-15T09:30:00Z",
464         "environment_id": "environment_id",
465         "event_subtype": "event_subtype",
466         "month_reset": "month_reset",
467         "period": "period",
468         "value": 1,
469         "valid_until": "2024-01-15T09:30:00Z"
470       }
471     ],
472     "name": "name",
473     "payment_methods": [
474       {
475         "created_at": "2024-01-15T09:30:00Z",
476         "customer_external_id": "customer_external_id",
477         "environment_id": "environment_id",
478         "external_id": "external_id",
479         "id": "id",
480         "payment_method_type": "payment_method_type",
481         "updated_at": "2024-01-15T09:30:00Z",
482         "account_last4": "account_last4",
483         "account_name": "account_name",
484         "bank_name": "bank_name",
485         "billing_email": "billing_email",
486         "billing_name": "billing_name",
487         "card_brand": "card_brand",
488         "card_exp_month": 1,
489         "card_exp_year": 1,
490         "card_last4": "card_last4",
491         "company_id": "company_id"
492       },
493       {
494         "created_at": "2024-01-15T09:30:00Z",
495         "customer_external_id": "customer_external_id",
496         "environment_id": "environment_id",
497         "external_id": "external_id",
498         "id": "id",
499         "payment_method_type": "payment_method_type",
500         "updated_at": "2024-01-15T09:30:00Z",
501         "account_last4": "account_last4",
502         "account_name": "account_name",
503         "bank_name": "bank_name",
504         "billing_email": "billing_email",
505         "billing_name": "billing_name",
506         "card_brand": "card_brand",
507         "card_exp_month": 1,
508         "card_exp_year": 1,
509         "card_last4": "card_last4",
510         "company_id": "company_id"
511       }
512     ],
513     "plans": [
514       {
515         "id": "id",
516         "name": "name",
517         "description": "description",
518         "image_url": "image_url"
519       },
520       {
521         "id": "id",
522         "name": "name",
523         "description": "description",
524         "image_url": "image_url"
525       }
526     ],
527     "updated_at": "2024-01-15T09:30:00Z",
528     "user_count": 1,
529     "billing_subscription": {
530       "cancel_at_period_end": true,
531       "created_at": "2024-01-15T09:30:00Z",
532       "currency": "currency",
533       "customer_external_id": "customer_external_id",
534       "discounts": [
535         {
536           "coupon_id": "coupon_id",
537           "coupon_name": "coupon_name",
538           "discount_external_id": "discount_external_id",
539           "duration": "duration",
540           "is_active": true,
541           "started_at": "2024-01-15T09:30:00Z",
542           "subscription_external_id": "subscription_external_id",
543           "amount_off": 1,
544           "currency": "currency",
545           "customer_facing_code": "customer_facing_code",
546           "duration_in_months": 1,
547           "ended_at": "2024-01-15T09:30:00Z",
548           "percent_off": 1.1,
549           "promo_code_external_id": "promo_code_external_id"
550         },
551         {
552           "coupon_id": "coupon_id",
553           "coupon_name": "coupon_name",
554           "discount_external_id": "discount_external_id",
555           "duration": "duration",
556           "is_active": true,
557           "started_at": "2024-01-15T09:30:00Z",
558           "subscription_external_id": "subscription_external_id",
559           "amount_off": 1,
560           "currency": "currency",
561           "customer_facing_code": "customer_facing_code",
562           "duration_in_months": 1,
563           "ended_at": "2024-01-15T09:30:00Z",
564           "percent_off": 1.1,
565           "promo_code_external_id": "promo_code_external_id"
566         }
567       ],
568       "id": "id",
569       "interval": "interval",
570       "period_end": 1,
571       "period_start": 1,
572       "products": [
573         {
574           "billing_scheme": "billing_scheme",
575           "created_at": "2024-01-15T09:30:00Z",
576           "currency": "currency",
577           "environment_id": "environment_id",
578           "external_id": "external_id",
579           "id": "id",
580           "interval": "interval",
581           "name": "name",
582           "package_size": 1,
583           "price": 1,
584           "price_external_id": "price_external_id",
585           "price_id": "price_id",
586           "price_tier": [
587             {
588               "flat_amount": 1,
589               "per_unit_price": 1,
590               "per_unit_price_decimal": "per_unit_price_decimal",
591               "up_to": 1
592             },
593             {
594               "flat_amount": 1,
595               "per_unit_price": 1,
596               "per_unit_price_decimal": "per_unit_price_decimal",
597               "up_to": 1
598             }
599           ],
600           "quantity": 1.1,
601           "subscription_id": "subscription_id",
602           "updated_at": "2024-01-15T09:30:00Z",
603           "usage_type": "usage_type",
604           "meter_id": "meter_id",
605           "price_decimal": "price_decimal"
606         },
607         {
608           "billing_scheme": "billing_scheme",
609           "created_at": "2024-01-15T09:30:00Z",
610           "currency": "currency",
611           "environment_id": "environment_id",
612           "external_id": "external_id",
613           "id": "id",
614           "interval": "interval",
615           "name": "name",
616           "package_size": 1,
617           "price": 1,
618           "price_external_id": "price_external_id",
619           "price_id": "price_id",
620           "price_tier": [
621             {
622               "flat_amount": 1,
623               "per_unit_price": 1,
624               "per_unit_price_decimal": "per_unit_price_decimal",
625               "up_to": 1
626             },
627             {
628               "flat_amount": 1,
629               "per_unit_price": 1,
630               "per_unit_price_decimal": "per_unit_price_decimal",
631               "up_to": 1
632             }
633           ],
634           "quantity": 1.1,
635           "subscription_id": "subscription_id",
636           "updated_at": "2024-01-15T09:30:00Z",
637           "usage_type": "usage_type",
638           "meter_id": "meter_id",
639           "price_decimal": "price_decimal"
640         }
641       ],
642       "status": "status",
643       "subscription_external_id": "subscription_external_id",
644       "total_price": 1,
645       "cancel_at": 1,
646       "company_id": "company_id",
647       "default_payment_method_id": "default_payment_method_id",
648       "expired_at": "2024-01-15T09:30:00Z",
649       "latest_invoice": {
650         "amount_due": 1,
651         "amount_paid": 1,
652         "amount_remaining": 1,
653         "collection_method": "collection_method",
654         "created_at": "2024-01-15T09:30:00Z",
655         "currency": "currency",
656         "customer_external_id": "customer_external_id",
657         "environment_id": "environment_id",
658         "id": "id",
659         "subtotal": 1,
660         "updated_at": "2024-01-15T09:30:00Z",
661         "company_id": "company_id",
662         "due_date": "2024-01-15T09:30:00Z",
663         "external_id": "external_id",
664         "payment_method_external_id": "payment_method_external_id",
665         "subscription_external_id": "subscription_external_id",
666         "url": "url"
667       },
668       "metadata": {
669         "metadata": {
670           "key": "value"
671         }
672       },
673       "payment_method": {
674         "created_at": "2024-01-15T09:30:00Z",
675         "customer_external_id": "customer_external_id",
676         "environment_id": "environment_id",
677         "external_id": "external_id",
678         "id": "id",
679         "payment_method_type": "payment_method_type",
680         "updated_at": "2024-01-15T09:30:00Z",
681         "account_last4": "account_last4",
682         "account_name": "account_name",
683         "bank_name": "bank_name",
684         "billing_email": "billing_email",
685         "billing_name": "billing_name",
686         "card_brand": "card_brand",
687         "card_exp_month": 1,
688         "card_exp_year": 1,
689         "card_last4": "card_last4",
690         "company_id": "company_id"
691       },
692       "trial_end": 1,
693       "trial_end_setting": "trial_end_setting"
694     },
695     "default_payment_method": {
696       "created_at": "2024-01-15T09:30:00Z",
697       "customer_external_id": "customer_external_id",
698       "environment_id": "environment_id",
699       "external_id": "external_id",
700       "id": "id",
701       "payment_method_type": "payment_method_type",
702       "updated_at": "2024-01-15T09:30:00Z",
703       "account_last4": "account_last4",
704       "account_name": "account_name",
705       "bank_name": "bank_name",
706       "billing_email": "billing_email",
707       "billing_name": "billing_name",
708       "card_brand": "card_brand",
709       "card_exp_month": 1,
710       "card_exp_year": 1,
711       "card_last4": "card_last4",
712       "company_id": "company_id"
713     },
714     "last_seen_at": "2024-01-15T09:30:00Z",
715     "logo_url": "logo_url",
716     "plan": {
717       "id": "id",
718       "name": "name",
719       "added_on": "2024-01-15T09:30:00Z",
720       "billing_product_external_id": "billing_product_external_id",
721       "billing_product_id": "billing_product_id",
722       "description": "description",
723       "image_url": "image_url",
724       "plan_period": "plan_period",
725       "plan_price": 1
726     },
727     "traits": {
728       "traits": {
729         "key": "value"
730       }
731     }
732   },
733   "params": {
734     "keys": {
735       "keys": "keys"
736     }
737   }
738 }

Query parameters

keysmap from strings to stringsRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Lookup company

Headers

Query parameters

Response

Errors