Lookup user

GET

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

GET

/users/lookup

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

Try it

1 {
2   "data": {
3     "company_memberships": [
4       {
5         "company_id": "company_id",
6         "created_at": "2024-01-15T09:30:00Z",
7         "id": "id",
8         "updated_at": "2024-01-15T09:30:00Z",
9         "user_id": "user_id",
10         "company": {
11           "created_at": "2024-01-15T09:30:00Z",
12           "environment_id": "environment_id",
13           "id": "id",
14           "name": "name",
15           "updated_at": "2024-01-15T09:30:00Z",
16           "last_seen_at": "2024-01-15T09:30:00Z",
17           "logo_url": "logo_url"
18         }
19       },
20       {
21         "company_id": "company_id",
22         "created_at": "2024-01-15T09:30:00Z",
23         "id": "id",
24         "updated_at": "2024-01-15T09:30:00Z",
25         "user_id": "user_id",
26         "company": {
27           "created_at": "2024-01-15T09:30:00Z",
28           "environment_id": "environment_id",
29           "id": "id",
30           "name": "name",
31           "updated_at": "2024-01-15T09:30:00Z",
32           "last_seen_at": "2024-01-15T09:30:00Z",
33           "logo_url": "logo_url"
34         }
35       }
36     ],
37     "created_at": "2024-01-15T09:30:00Z",
38     "entity_traits": [
39       {
40         "created_at": "2024-01-15T09:30:00Z",
41         "definition_id": "definition_id",
42         "environment_id": "environment_id",
43         "id": "id",
44         "updated_at": "2024-01-15T09:30:00Z",
45         "value": "value",
46         "definition": {
47           "created_at": "2024-01-15T09:30:00Z",
48           "display_name": "display_name",
49           "entity_type": "entity_type",
50           "hierarchy": [
51             "hierarchy",
52             "hierarchy"
53           ],
54           "id": "id",
55           "trait_type": "trait_type",
56           "updated_at": "2024-01-15T09:30:00Z"
57         }
58       },
59       {
60         "created_at": "2024-01-15T09:30:00Z",
61         "definition_id": "definition_id",
62         "environment_id": "environment_id",
63         "id": "id",
64         "updated_at": "2024-01-15T09:30:00Z",
65         "value": "value",
66         "definition": {
67           "created_at": "2024-01-15T09:30:00Z",
68           "display_name": "display_name",
69           "entity_type": "entity_type",
70           "hierarchy": [
71             "hierarchy",
72             "hierarchy"
73           ],
74           "id": "id",
75           "trait_type": "trait_type",
76           "updated_at": "2024-01-15T09:30:00Z"
77         }
78       }
79     ],
80     "environment_id": "environment_id",
81     "id": "id",
82     "keys": [
83       {
84         "created_at": "2024-01-15T09:30:00Z",
85         "definition_id": "definition_id",
86         "entity_id": "entity_id",
87         "entity_type": "entity_type",
88         "environment_id": "environment_id",
89         "id": "id",
90         "key": "key",
91         "updated_at": "2024-01-15T09:30:00Z",
92         "value": "value",
93         "definition": {
94           "created_at": "2024-01-15T09:30:00Z",
95           "entity_type": "entity_type",
96           "id": "id",
97           "key": "key",
98           "updated_at": "2024-01-15T09:30:00Z"
99         }
100       },
101       {
102         "created_at": "2024-01-15T09:30:00Z",
103         "definition_id": "definition_id",
104         "entity_id": "entity_id",
105         "entity_type": "entity_type",
106         "environment_id": "environment_id",
107         "id": "id",
108         "key": "key",
109         "updated_at": "2024-01-15T09:30:00Z",
110         "value": "value",
111         "definition": {
112           "created_at": "2024-01-15T09:30:00Z",
113           "entity_type": "entity_type",
114           "id": "id",
115           "key": "key",
116           "updated_at": "2024-01-15T09:30:00Z"
117         }
118       }
119     ],
120     "name": "name",
121     "updated_at": "2024-01-15T09:30:00Z",
122     "last_seen_at": "2024-01-15T09:30:00Z",
123     "traits": {
124       "traits": {
125         "key": "value"
126       }
127     }
128   },
129   "params": {
130     "keys": {
131       "keys": "keys"
132     }
133   }
134 }

Query parameters

keysmap from strings to stringsRequired

Key/value pairs

Response

dataobject

paramsobject

Input parameters

Lookup user

Headers

Query parameters

Response

Errors