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         "currency": "string",
17         "external_id": "string",
18         "id": "string",
19         "interval": "string",
20         "total_price": 0,
21         "updated_at": "2023-01-01T00:00:00Z",
22         "expired_at": "2023-01-01T00:00:00Z"
23       }
24     ],
25     "created_at": "2023-01-01T00:00:00Z",
26     "entity_traits": [
27       {
28         "created_at": "2023-01-01T00:00:00Z",
29         "definition_id": "string",
30         "environment_id": "string",
31         "id": "string",
32         "updated_at": "2023-01-01T00:00:00Z",
33         "value": "string",
34         "definition": {
35           "created_at": "2023-01-01T00:00:00Z",
36           "display_name": "string",
37           "entity_type": "string",
38           "hierarchy": [
39             "string"
40           ],
41           "id": "string",
42           "trait_type": "string",
43           "updated_at": "2023-01-01T00:00:00Z"
44         }
45       }
46     ],
47     "environment_id": "string",
48     "id": "string",
49     "keys": [
50       {
51         "created_at": "2023-01-01T00:00:00Z",
52         "definition_id": "string",
53         "entity_id": "string",
54         "entity_type": "string",
55         "environment_id": "string",
56         "id": "string",
57         "key": "string",
58         "updated_at": "2023-01-01T00:00:00Z",
59         "value": "string",
60         "definition": {
61           "created_at": "2023-01-01T00:00:00Z",
62           "entity_type": "string",
63           "id": "string",
64           "key": "string",
65           "updated_at": "2023-01-01T00:00:00Z"
66         }
67       }
68     ],
69     "name": "string",
70     "plans": [
71       {
72         "id": "string",
73         "name": "string",
74         "description": "string",
75         "image_url": "string"
76       }
77     ],
78     "updated_at": "2023-01-01T00:00:00Z",
79     "user_count": 0,
80     "last_seen_at": "2023-01-01T00:00:00Z",
81     "logo_url": "string",
82     "plan": {
83       "id": "string",
84       "name": "string",
85       "billing_product_id": "string",
86       "description": "string",
87       "image_url": "string",
88       "plan_period": "string",
89       "plan_price": 0
90     },
91     "traits": {
92       "string": {}
93     }
94   },
95   "params": {
96     "keys": {
97       "string": {}
98     }
99   }
100 }

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	"currency": "string",
17	"external_id": "string",
18	"id": "string",
19	"interval": "string",
20	"total_price": 0,
21	"updated_at": "2023-01-01T00:00:00Z",
22	"expired_at": "2023-01-01T00:00:00Z"
23	}
24	],
25	"created_at": "2023-01-01T00:00:00Z",
26	"entity_traits": [
27	{
28	"created_at": "2023-01-01T00:00:00Z",
29	"definition_id": "string",
30	"environment_id": "string",
31	"id": "string",
32	"updated_at": "2023-01-01T00:00:00Z",
33	"value": "string",
34	"definition": {
35	"created_at": "2023-01-01T00:00:00Z",
36	"display_name": "string",
37	"entity_type": "string",
38	"hierarchy": [
39	"string"
40	],
41	"id": "string",
42	"trait_type": "string",
43	"updated_at": "2023-01-01T00:00:00Z"
44	}
45	}
46	],
47	"environment_id": "string",
48	"id": "string",
49	"keys": [
50	{
51	"created_at": "2023-01-01T00:00:00Z",
52	"definition_id": "string",
53	"entity_id": "string",
54	"entity_type": "string",
55	"environment_id": "string",
56	"id": "string",
57	"key": "string",
58	"updated_at": "2023-01-01T00:00:00Z",
59	"value": "string",
60	"definition": {
61	"created_at": "2023-01-01T00:00:00Z",
62	"entity_type": "string",
63	"id": "string",
64	"key": "string",
65	"updated_at": "2023-01-01T00:00:00Z"
66	}
67	}
68	],
69	"name": "string",
70	"plans": [
71	{
72	"id": "string",
73	"name": "string",
74	"description": "string",
75	"image_url": "string"
76	}
77	],
78	"updated_at": "2023-01-01T00:00:00Z",
79	"user_count": 0,
80	"last_seen_at": "2023-01-01T00:00:00Z",
81	"logo_url": "string",
82	"plan": {
83	"id": "string",
84	"name": "string",
85	"billing_product_id": "string",
86	"description": "string",
87	"image_url": "string",
88	"plan_period": "string",
89	"plan_price": 0
90	},
91	"traits": {
92	"string": {}
93	}
94	},
95	"params": {
96	"keys": {
97	"string": {}
98	}
99	}
100	}