Lookup user

GET

Query parameters

keysmap from strings to anyRequired

Key/value pairs

Response

This endpoint returns an object

dataobject

paramsobject

Input parameters

GET

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

200Retrieved

1 {
2   "data": {
3     "company_memberships": [
4       {
5         "company": {
6           "created_at": "2023-01-01T00:00:00Z",
7           "environment_id": "string",
8           "id": "string",
9           "last_seen_at": "2023-01-01T00:00:00Z",
10           "logo_url": "string",
11           "name": "string",
12           "updated_at": "2023-01-01T00:00:00Z"
13         },
14         "company_id": "string",
15         "created_at": "2023-01-01T00:00:00Z",
16         "id": "string",
17         "updated_at": "2023-01-01T00:00:00Z",
18         "user_id": "string"
19       }
20     ],
21     "created_at": "2023-01-01T00:00:00Z",
22     "entity_traits": [
23       {
24         "created_at": "2023-01-01T00:00:00Z",
25         "definition": {
26           "created_at": "2023-01-01T00:00:00Z",
27           "display_name": "string",
28           "entity_type": "string",
29           "hierarchy": [
30             "string"
31           ],
32           "id": "string",
33           "trait_type": "string",
34           "updated_at": "2023-01-01T00:00:00Z"
35         },
36         "definition_id": "string",
37         "environment_id": "string",
38         "id": "string",
39         "updated_at": "2023-01-01T00:00:00Z",
40         "value": "string"
41       }
42     ],
43     "environment_id": "string",
44     "id": "string",
45     "keys": [
46       {
47         "created_at": "2023-01-01T00:00:00Z",
48         "definition": {
49           "created_at": "2023-01-01T00:00:00Z",
50           "entity_type": "string",
51           "id": "string",
52           "key": "string",
53           "updated_at": "2023-01-01T00:00:00Z"
54         },
55         "definition_id": "string",
56         "entity_id": "string",
57         "entity_type": "string",
58         "environment_id": "string",
59         "id": "string",
60         "key": "string",
61         "updated_at": "2023-01-01T00:00:00Z",
62         "value": "string"
63       }
64     ],
65     "last_seen_at": "2023-01-01T00:00:00Z",
66     "name": "string",
67     "traits": {
68       "string": {}
69     },
70     "updated_at": "2023-01-01T00:00:00Z"
71   },
72   "params": {
73     "keys": {
74       "string": {}
75     }
76   }
77 }

Built with

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

1	{
2	"data": {
3	"company_memberships": [
4	{
5	"company": {
6	"created_at": "2023-01-01T00:00:00Z",
7	"environment_id": "string",
8	"id": "string",
9	"last_seen_at": "2023-01-01T00:00:00Z",
10	"logo_url": "string",
11	"name": "string",
12	"updated_at": "2023-01-01T00:00:00Z"
13	},
14	"company_id": "string",
15	"created_at": "2023-01-01T00:00:00Z",
16	"id": "string",
17	"updated_at": "2023-01-01T00:00:00Z",
18	"user_id": "string"
19	}
20	],
21	"created_at": "2023-01-01T00:00:00Z",
22	"entity_traits": [
23	{
24	"created_at": "2023-01-01T00:00:00Z",
25	"definition": {
26	"created_at": "2023-01-01T00:00:00Z",
27	"display_name": "string",
28	"entity_type": "string",
29	"hierarchy": [
30	"string"
31	],
32	"id": "string",
33	"trait_type": "string",
34	"updated_at": "2023-01-01T00:00:00Z"
35	},
36	"definition_id": "string",
37	"environment_id": "string",
38	"id": "string",
39	"updated_at": "2023-01-01T00:00:00Z",
40	"value": "string"
41	}
42	],
43	"environment_id": "string",
44	"id": "string",
45	"keys": [
46	{
47	"created_at": "2023-01-01T00:00:00Z",
48	"definition": {
49	"created_at": "2023-01-01T00:00:00Z",
50	"entity_type": "string",
51	"id": "string",
52	"key": "string",
53	"updated_at": "2023-01-01T00:00:00Z"
54	},
55	"definition_id": "string",
56	"entity_id": "string",
57	"entity_type": "string",
58	"environment_id": "string",
59	"id": "string",
60	"key": "string",
61	"updated_at": "2023-01-01T00:00:00Z",
62	"value": "string"
63	}
64	],
65	"last_seen_at": "2023-01-01T00:00:00Z",
66	"name": "string",
67	"traits": {
68	"string": {}
69	},
70	"updated_at": "2023-01-01T00:00:00Z"
71	},
72	"params": {
73	"keys": {
74	"string": {}
75	}
76	}
77	}