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": {
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         "default_payment_method_id": "default_payment_method_id",
109         "expired_at": "2024-01-15T09:30:00Z",
110         "latest_invoice": {
111           "amount_due": 1,
112           "amount_paid": 1,
113           "amount_remaining": 1,
114           "collection_method": "collection_method",
115           "created_at": "2024-01-15T09:30:00Z",
116           "currency": "currency",
117           "customer_external_id": "customer_external_id",
118           "environment_id": "environment_id",
119           "id": "id",
120           "subtotal": 1,
121           "updated_at": "2024-01-15T09:30:00Z",
122           "company_id": "company_id",
123           "due_date": "2024-01-15T09:30:00Z",
124           "external_id": "external_id",
125           "payment_method_external_id": "payment_method_external_id",
126           "subscription_external_id": "subscription_external_id",
127           "url": "url"
128         },
129         "metadata": {
130           "metadata": {
131             "key": "value"
132           }
133         },
134         "payment_method": {
135           "created_at": "2024-01-15T09:30:00Z",
136           "customer_external_id": "customer_external_id",
137           "environment_id": "environment_id",
138           "external_id": "external_id",
139           "id": "id",
140           "payment_method_type": "payment_method_type",
141           "updated_at": "2024-01-15T09:30:00Z",
142           "account_last4": "account_last4",
143           "account_name": "account_name",
144           "bank_name": "bank_name",
145           "billing_email": "billing_email",
146           "billing_name": "billing_name",
147           "card_brand": "card_brand",
148           "card_exp_month": 1,
149           "card_exp_year": 1,
150           "card_last4": "card_last4",
151           "company_id": "company_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         "default_payment_method_id": "default_payment_method_id",
241         "expired_at": "2024-01-15T09:30:00Z",
242         "latest_invoice": {
243           "amount_due": 1,
244           "amount_paid": 1,
245           "amount_remaining": 1,
246           "collection_method": "collection_method",
247           "created_at": "2024-01-15T09:30:00Z",
248           "currency": "currency",
249           "customer_external_id": "customer_external_id",
250           "environment_id": "environment_id",
251           "id": "id",
252           "subtotal": 1,
253           "updated_at": "2024-01-15T09:30:00Z",
254           "company_id": "company_id",
255           "due_date": "2024-01-15T09:30:00Z",
256           "external_id": "external_id",
257           "payment_method_external_id": "payment_method_external_id",
258           "subscription_external_id": "subscription_external_id",
259           "url": "url"
260         },
261         "metadata": {
262           "metadata": {
263             "key": "value"
264           }
265         },
266         "payment_method": {
267           "created_at": "2024-01-15T09:30:00Z",
268           "customer_external_id": "customer_external_id",
269           "environment_id": "environment_id",
270           "external_id": "external_id",
271           "id": "id",
272           "payment_method_type": "payment_method_type",
273           "updated_at": "2024-01-15T09:30:00Z",
274           "account_last4": "account_last4",
275           "account_name": "account_name",
276           "bank_name": "bank_name",
277           "billing_email": "billing_email",
278           "billing_name": "billing_name",
279           "card_brand": "card_brand",
280           "card_exp_month": 1,
281           "card_exp_year": 1,
282           "card_last4": "card_last4",
283           "company_id": "company_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     "payment_methods": [
402       {
403         "created_at": "2024-01-15T09:30:00Z",
404         "customer_external_id": "customer_external_id",
405         "environment_id": "environment_id",
406         "external_id": "external_id",
407         "id": "id",
408         "payment_method_type": "payment_method_type",
409         "updated_at": "2024-01-15T09:30:00Z",
410         "account_last4": "account_last4",
411         "account_name": "account_name",
412         "bank_name": "bank_name",
413         "billing_email": "billing_email",
414         "billing_name": "billing_name",
415         "card_brand": "card_brand",
416         "card_exp_month": 1,
417         "card_exp_year": 1,
418         "card_last4": "card_last4",
419         "company_id": "company_id"
420       },
421       {
422         "created_at": "2024-01-15T09:30:00Z",
423         "customer_external_id": "customer_external_id",
424         "environment_id": "environment_id",
425         "external_id": "external_id",
426         "id": "id",
427         "payment_method_type": "payment_method_type",
428         "updated_at": "2024-01-15T09:30:00Z",
429         "account_last4": "account_last4",
430         "account_name": "account_name",
431         "bank_name": "bank_name",
432         "billing_email": "billing_email",
433         "billing_name": "billing_name",
434         "card_brand": "card_brand",
435         "card_exp_month": 1,
436         "card_exp_year": 1,
437         "card_last4": "card_last4",
438         "company_id": "company_id"
439       }
440     ],
441     "plans": [
442       {
443         "id": "id",
444         "name": "name",
445         "description": "description",
446         "image_url": "image_url"
447       },
448       {
449         "id": "id",
450         "name": "name",
451         "description": "description",
452         "image_url": "image_url"
453       }
454     ],
455     "updated_at": "2024-01-15T09:30:00Z",
456     "user_count": 1,
457     "billing_subscription": {
458       "cancel_at_period_end": true,
459       "created_at": "2024-01-15T09:30:00Z",
460       "currency": "currency",
461       "customer_external_id": "customer_external_id",
462       "discounts": [
463         {
464           "coupon_id": "coupon_id",
465           "coupon_name": "coupon_name",
466           "discount_external_id": "discount_external_id",
467           "duration": "duration",
468           "is_active": true,
469           "started_at": "2024-01-15T09:30:00Z",
470           "subscription_external_id": "subscription_external_id",
471           "amount_off": 1,
472           "currency": "currency",
473           "customer_facing_code": "customer_facing_code",
474           "duration_in_months": 1,
475           "ended_at": "2024-01-15T09:30:00Z",
476           "percent_off": 1.1,
477           "promo_code_external_id": "promo_code_external_id"
478         },
479         {
480           "coupon_id": "coupon_id",
481           "coupon_name": "coupon_name",
482           "discount_external_id": "discount_external_id",
483           "duration": "duration",
484           "is_active": true,
485           "started_at": "2024-01-15T09:30:00Z",
486           "subscription_external_id": "subscription_external_id",
487           "amount_off": 1,
488           "currency": "currency",
489           "customer_facing_code": "customer_facing_code",
490           "duration_in_months": 1,
491           "ended_at": "2024-01-15T09:30:00Z",
492           "percent_off": 1.1,
493           "promo_code_external_id": "promo_code_external_id"
494         }
495       ],
496       "id": "id",
497       "interval": "interval",
498       "period_end": 1,
499       "period_start": 1,
500       "products": [
501         {
502           "created_at": "2024-01-15T09:30:00Z",
503           "currency": "currency",
504           "environment_id": "environment_id",
505           "external_id": "external_id",
506           "id": "id",
507           "interval": "interval",
508           "name": "name",
509           "price": 1,
510           "price_external_id": "price_external_id",
511           "price_id": "price_id",
512           "quantity": 1.1,
513           "subscription_id": "subscription_id",
514           "updated_at": "2024-01-15T09:30:00Z",
515           "usage_type": "usage_type",
516           "meter_id": "meter_id"
517         },
518         {
519           "created_at": "2024-01-15T09:30:00Z",
520           "currency": "currency",
521           "environment_id": "environment_id",
522           "external_id": "external_id",
523           "id": "id",
524           "interval": "interval",
525           "name": "name",
526           "price": 1,
527           "price_external_id": "price_external_id",
528           "price_id": "price_id",
529           "quantity": 1.1,
530           "subscription_id": "subscription_id",
531           "updated_at": "2024-01-15T09:30:00Z",
532           "usage_type": "usage_type",
533           "meter_id": "meter_id"
534         }
535       ],
536       "status": "status",
537       "subscription_external_id": "subscription_external_id",
538       "total_price": 1,
539       "cancel_at": 1,
540       "company_id": "company_id",
541       "default_payment_method_id": "default_payment_method_id",
542       "expired_at": "2024-01-15T09:30:00Z",
543       "latest_invoice": {
544         "amount_due": 1,
545         "amount_paid": 1,
546         "amount_remaining": 1,
547         "collection_method": "collection_method",
548         "created_at": "2024-01-15T09:30:00Z",
549         "currency": "currency",
550         "customer_external_id": "customer_external_id",
551         "environment_id": "environment_id",
552         "id": "id",
553         "subtotal": 1,
554         "updated_at": "2024-01-15T09:30:00Z",
555         "company_id": "company_id",
556         "due_date": "2024-01-15T09:30:00Z",
557         "external_id": "external_id",
558         "payment_method_external_id": "payment_method_external_id",
559         "subscription_external_id": "subscription_external_id",
560         "url": "url"
561       },
562       "metadata": {
563         "metadata": {
564           "key": "value"
565         }
566       },
567       "payment_method": {
568         "created_at": "2024-01-15T09:30:00Z",
569         "customer_external_id": "customer_external_id",
570         "environment_id": "environment_id",
571         "external_id": "external_id",
572         "id": "id",
573         "payment_method_type": "payment_method_type",
574         "updated_at": "2024-01-15T09:30:00Z",
575         "account_last4": "account_last4",
576         "account_name": "account_name",
577         "bank_name": "bank_name",
578         "billing_email": "billing_email",
579         "billing_name": "billing_name",
580         "card_brand": "card_brand",
581         "card_exp_month": 1,
582         "card_exp_year": 1,
583         "card_last4": "card_last4",
584         "company_id": "company_id"
585       },
586       "trial_end": 1,
587       "trial_end_setting": "trial_end_setting"
588     },
589     "last_seen_at": "2024-01-15T09:30:00Z",
590     "logo_url": "logo_url",
591     "plan": {
592       "id": "id",
593       "name": "name",
594       "billing_product_id": "billing_product_id",
595       "description": "description",
596       "image_url": "image_url",
597       "plan_period": "plan_period",
598       "plan_price": 1
599     },
600     "traits": {
601       "traits": {
602         "key": "value"
603       }
604     }
605   },
606   "params": {
607     "keys": {
608       "keys": {
609         "key": "value"
610       }
611     }
612   }
613 }

Query parameters

keysmap from strings to anyRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Lookup company

Headers

Query parameters

Response

Errors