Lookup company

GET

Query parameters

keysmap from strings to anyRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

GET

1 curl -G https://api.schematichq.com/companies/lookup \
2      -H "X-Schematic-Api-Key: <apiKey>" \
3      --data-urlencode keys={"string":{}}

200Retrieved

1 {
2   "data": {
3     "add_ons": [
4       {
5         "id": "string",
6         "name": "string",
7         "billing_product_id": "string",
8         "description": "string",
9         "image_url": "string",
10         "plan_period": "string",
11         "plan_price": 0
12       }
13     ],
14     "billing_subscriptions": [
15       {
16         "created_at": "2023-01-01T00:00:00Z",
17         "currency": "string",
18         "customer_external_id": "string",
19         "id": "string",
20         "interval": "string",
21         "period_end": 0,
22         "period_start": 0,
23         "products": [
24           {
25             "created_at": "2023-01-01T00:00:00Z",
26             "currency": "string",
27             "environment_id": "string",
28             "external_id": "string",
29             "id": "string",
30             "interval": "string",
31             "name": "string",
32             "price": 0,
33             "price_external_id": "string",
34             "quantity": 1,
35             "subscription_id": "string",
36             "updated_at": "2023-01-01T00:00:00Z",
37             "usage_type": "string",
38             "meter_id": "string"
39           }
40         ],
41         "status": "string",
42         "subscription_external_id": "string",
43         "total_price": 0,
44         "company_id": "string",
45         "expired_at": "2023-01-01T00:00:00Z",
46         "latest_invoice": {
47           "amount_due": 0,
48           "amount_paid": 0,
49           "amount_remaining": 0,
50           "collection_method": "string",
51           "created_at": "2023-01-01T00:00:00Z",
52           "currency": "string",
53           "customer_external_id": "string",
54           "environment_id": "string",
55           "id": "string",
56           "subtotal": 0,
57           "updated_at": "2023-01-01T00:00:00Z",
58           "company_id": "string",
59           "due_date": "2023-01-01T00:00:00Z",
60           "external_id": "string",
61           "payment_method_external_id": "string",
62           "subscription_external_id": "string",
63           "url": "string"
64         },
65         "metadata": {
66           "string": {}
67         },
68         "payment_method": {
69           "created_at": "2023-01-01T00:00:00Z",
70           "customer_external_id": "string",
71           "environment_id": "string",
72           "external_id": "string",
73           "id": "string",
74           "payment_method_type": "string",
75           "updated_at": "2023-01-01T00:00:00Z",
76           "account_last4": "string",
77           "account_name": "string",
78           "bank_name": "string",
79           "billing_email": "string",
80           "billing_name": "string",
81           "card_brand": "string",
82           "card_exp_month": 0,
83           "card_exp_year": 0,
84           "card_last4": "string",
85           "company_id": "string",
86           "subscription_external_id": "string"
87         }
88       }
89     ],
90     "created_at": "2023-01-01T00:00:00Z",
91     "entity_traits": [
92       {
93         "created_at": "2023-01-01T00:00:00Z",
94         "definition_id": "string",
95         "environment_id": "string",
96         "id": "string",
97         "updated_at": "2023-01-01T00:00:00Z",
98         "value": "string",
99         "definition": {
100           "created_at": "2023-01-01T00:00:00Z",
101           "display_name": "string",
102           "entity_type": "string",
103           "hierarchy": [
104             "string"
105           ],
106           "id": "string",
107           "trait_type": "string",
108           "updated_at": "2023-01-01T00:00:00Z"
109         }
110       }
111     ],
112     "environment_id": "string",
113     "id": "string",
114     "keys": [
115       {
116         "created_at": "2023-01-01T00:00:00Z",
117         "definition_id": "string",
118         "entity_id": "string",
119         "entity_type": "string",
120         "environment_id": "string",
121         "id": "string",
122         "key": "string",
123         "updated_at": "2023-01-01T00:00:00Z",
124         "value": "string",
125         "definition": {
126           "created_at": "2023-01-01T00:00:00Z",
127           "entity_type": "string",
128           "id": "string",
129           "key": "string",
130           "updated_at": "2023-01-01T00:00:00Z"
131         }
132       }
133     ],
134     "name": "string",
135     "plans": [
136       {
137         "id": "string",
138         "name": "string",
139         "description": "string",
140         "image_url": "string"
141       }
142     ],
143     "updated_at": "2023-01-01T00:00:00Z",
144     "user_count": 0,
145     "billing_subscription": {
146       "created_at": "2023-01-01T00:00:00Z",
147       "currency": "string",
148       "customer_external_id": "string",
149       "id": "string",
150       "interval": "string",
151       "period_end": 0,
152       "period_start": 0,
153       "products": [
154         {
155           "created_at": "2023-01-01T00:00:00Z",
156           "currency": "string",
157           "environment_id": "string",
158           "external_id": "string",
159           "id": "string",
160           "interval": "string",
161           "name": "string",
162           "price": 0,
163           "price_external_id": "string",
164           "quantity": 1,
165           "subscription_id": "string",
166           "updated_at": "2023-01-01T00:00:00Z",
167           "usage_type": "string",
168           "meter_id": "string"
169         }
170       ],
171       "status": "string",
172       "subscription_external_id": "string",
173       "total_price": 0,
174       "company_id": "string",
175       "expired_at": "2023-01-01T00:00:00Z",
176       "latest_invoice": {
177         "amount_due": 0,
178         "amount_paid": 0,
179         "amount_remaining": 0,
180         "collection_method": "string",
181         "created_at": "2023-01-01T00:00:00Z",
182         "currency": "string",
183         "customer_external_id": "string",
184         "environment_id": "string",
185         "id": "string",
186         "subtotal": 0,
187         "updated_at": "2023-01-01T00:00:00Z",
188         "company_id": "string",
189         "due_date": "2023-01-01T00:00:00Z",
190         "external_id": "string",
191         "payment_method_external_id": "string",
192         "subscription_external_id": "string",
193         "url": "string"
194       },
195       "metadata": {
196         "string": {}
197       },
198       "payment_method": {
199         "created_at": "2023-01-01T00:00:00Z",
200         "customer_external_id": "string",
201         "environment_id": "string",
202         "external_id": "string",
203         "id": "string",
204         "payment_method_type": "string",
205         "updated_at": "2023-01-01T00:00:00Z",
206         "account_last4": "string",
207         "account_name": "string",
208         "bank_name": "string",
209         "billing_email": "string",
210         "billing_name": "string",
211         "card_brand": "string",
212         "card_exp_month": 0,
213         "card_exp_year": 0,
214         "card_last4": "string",
215         "company_id": "string",
216         "subscription_external_id": "string"
217       }
218     },
219     "last_seen_at": "2023-01-01T00:00:00Z",
220     "logo_url": "string",
221     "plan": {
222       "id": "string",
223       "name": "string",
224       "billing_product_id": "string",
225       "description": "string",
226       "image_url": "string",
227       "plan_period": "string",
228       "plan_price": 0
229     },
230     "traits": {
231       "string": {}
232     }
233   },
234   "params": {
235     "keys": {
236       "string": {}
237     }
238   }
239 }

Built with

1	curl -G https://api.schematichq.com/companies/lookup \
2	-H "X-Schematic-Api-Key: <apiKey>" \
3	--data-urlencode keys={"string":{}}

1	{
2	"data": {
3	"add_ons": [
4	{
5	"id": "string",
6	"name": "string",
7	"billing_product_id": "string",
8	"description": "string",
9	"image_url": "string",
10	"plan_period": "string",
11	"plan_price": 0
12	}
13	],
14	"billing_subscriptions": [
15	{
16	"created_at": "2023-01-01T00:00:00Z",
17	"currency": "string",
18	"customer_external_id": "string",
19	"id": "string",
20	"interval": "string",
21	"period_end": 0,
22	"period_start": 0,
23	"products": [
24	{
25	"created_at": "2023-01-01T00:00:00Z",
26	"currency": "string",
27	"environment_id": "string",
28	"external_id": "string",
29	"id": "string",
30	"interval": "string",
31	"name": "string",
32	"price": 0,
33	"price_external_id": "string",
34	"quantity": 1,
35	"subscription_id": "string",
36	"updated_at": "2023-01-01T00:00:00Z",
37	"usage_type": "string",
38	"meter_id": "string"
39	}
40	],
41	"status": "string",
42	"subscription_external_id": "string",
43	"total_price": 0,
44	"company_id": "string",
45	"expired_at": "2023-01-01T00:00:00Z",
46	"latest_invoice": {
47	"amount_due": 0,
48	"amount_paid": 0,
49	"amount_remaining": 0,
50	"collection_method": "string",
51	"created_at": "2023-01-01T00:00:00Z",
52	"currency": "string",
53	"customer_external_id": "string",
54	"environment_id": "string",
55	"id": "string",
56	"subtotal": 0,
57	"updated_at": "2023-01-01T00:00:00Z",
58	"company_id": "string",
59	"due_date": "2023-01-01T00:00:00Z",
60	"external_id": "string",
61	"payment_method_external_id": "string",
62	"subscription_external_id": "string",
63	"url": "string"
64	},
65	"metadata": {
66	"string": {}
67	},
68	"payment_method": {
69	"created_at": "2023-01-01T00:00:00Z",
70	"customer_external_id": "string",
71	"environment_id": "string",
72	"external_id": "string",
73	"id": "string",
74	"payment_method_type": "string",
75	"updated_at": "2023-01-01T00:00:00Z",
76	"account_last4": "string",
77	"account_name": "string",
78	"bank_name": "string",
79	"billing_email": "string",
80	"billing_name": "string",
81	"card_brand": "string",
82	"card_exp_month": 0,
83	"card_exp_year": 0,
84	"card_last4": "string",
85	"company_id": "string",
86	"subscription_external_id": "string"
87	}
88	}
89	],
90	"created_at": "2023-01-01T00:00:00Z",
91	"entity_traits": [
92	{
93	"created_at": "2023-01-01T00:00:00Z",
94	"definition_id": "string",
95	"environment_id": "string",
96	"id": "string",
97	"updated_at": "2023-01-01T00:00:00Z",
98	"value": "string",
99	"definition": {
100	"created_at": "2023-01-01T00:00:00Z",
101	"display_name": "string",
102	"entity_type": "string",
103	"hierarchy": [
104	"string"
105	],
106	"id": "string",
107	"trait_type": "string",
108	"updated_at": "2023-01-01T00:00:00Z"
109	}
110	}
111	],
112	"environment_id": "string",
113	"id": "string",
114	"keys": [
115	{
116	"created_at": "2023-01-01T00:00:00Z",
117	"definition_id": "string",
118	"entity_id": "string",
119	"entity_type": "string",
120	"environment_id": "string",
121	"id": "string",
122	"key": "string",
123	"updated_at": "2023-01-01T00:00:00Z",
124	"value": "string",
125	"definition": {
126	"created_at": "2023-01-01T00:00:00Z",
127	"entity_type": "string",
128	"id": "string",
129	"key": "string",
130	"updated_at": "2023-01-01T00:00:00Z"
131	}
132	}
133	],
134	"name": "string",
135	"plans": [
136	{
137	"id": "string",
138	"name": "string",
139	"description": "string",
140	"image_url": "string"
141	}
142	],
143	"updated_at": "2023-01-01T00:00:00Z",
144	"user_count": 0,
145	"billing_subscription": {
146	"created_at": "2023-01-01T00:00:00Z",
147	"currency": "string",
148	"customer_external_id": "string",
149	"id": "string",
150	"interval": "string",
151	"period_end": 0,
152	"period_start": 0,
153	"products": [
154	{
155	"created_at": "2023-01-01T00:00:00Z",
156	"currency": "string",
157	"environment_id": "string",
158	"external_id": "string",
159	"id": "string",
160	"interval": "string",
161	"name": "string",
162	"price": 0,
163	"price_external_id": "string",
164	"quantity": 1,
165	"subscription_id": "string",
166	"updated_at": "2023-01-01T00:00:00Z",
167	"usage_type": "string",
168	"meter_id": "string"
169	}
170	],
171	"status": "string",
172	"subscription_external_id": "string",
173	"total_price": 0,
174	"company_id": "string",
175	"expired_at": "2023-01-01T00:00:00Z",
176	"latest_invoice": {
177	"amount_due": 0,
178	"amount_paid": 0,
179	"amount_remaining": 0,
180	"collection_method": "string",
181	"created_at": "2023-01-01T00:00:00Z",
182	"currency": "string",
183	"customer_external_id": "string",
184	"environment_id": "string",
185	"id": "string",
186	"subtotal": 0,
187	"updated_at": "2023-01-01T00:00:00Z",
188	"company_id": "string",
189	"due_date": "2023-01-01T00:00:00Z",
190	"external_id": "string",
191	"payment_method_external_id": "string",
192	"subscription_external_id": "string",
193	"url": "string"
194	},
195	"metadata": {
196	"string": {}
197	},
198	"payment_method": {
199	"created_at": "2023-01-01T00:00:00Z",
200	"customer_external_id": "string",
201	"environment_id": "string",
202	"external_id": "string",
203	"id": "string",
204	"payment_method_type": "string",
205	"updated_at": "2023-01-01T00:00:00Z",
206	"account_last4": "string",
207	"account_name": "string",
208	"bank_name": "string",
209	"billing_email": "string",
210	"billing_name": "string",
211	"card_brand": "string",
212	"card_exp_month": 0,
213	"card_exp_year": 0,
214	"card_last4": "string",
215	"company_id": "string",
216	"subscription_external_id": "string"
217	}
218	},
219	"last_seen_at": "2023-01-01T00:00:00Z",
220	"logo_url": "string",
221	"plan": {
222	"id": "string",
223	"name": "string",
224	"billing_product_id": "string",
225	"description": "string",
226	"image_url": "string",
227	"plan_period": "string",
228	"plan_price": 0
229	},
230	"traits": {
231	"string": {}
232	}
233	},
234	"params": {
235	"keys": {
236	"string": {}
237	}
238	}
239	}