List users

GET

https://api.schematichq.com/users

GET

/users

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 const client = new SchematicClient({ apiKey: "YOUR_API_KEY" });
4 await client.companies.listUsers();

Try it

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

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Query parameters

company_idstringOptional

Filter users by company ID (starts with comp_)

idslist of stringsOptional

Filter users by multiple user IDs (starts with user_)

plan_idstringOptional

Filter users by plan ID (starts with plan_)

qstringOptional

Search for users by name, keys or string traits

limitintegerOptional

Page limit (default 100)

offsetintegerOptional

Page offset (default 0)

Response

datalist of objects

paramsobject

Input parameters

Authentication

Query parameters

Response

Errors