List users

GET

Query parameters

company_idstringOptional

Filter users by company ID (starts with comp_)

idsstringOptional

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

The returned resources

paramsobject

Input parameters

GET

1 curl https://api.schematichq.com/users \
2      -H "X-Schematic-Api-Key: <apiKey>"

200Retrieved

1 {
2   "data": [
3     {
4       "company_memberships": [
5         {
6           "company_id": "company_id",
7           "created_at": "2024-01-15T09:30:00Z",
8           "id": "id",
9           "updated_at": "2024-01-15T09:30:00Z",
10           "user_id": "user_id"
11         }
12       ],
13       "created_at": "2024-01-15T09:30:00Z",
14       "entity_traits": [
15         {
16           "created_at": "2024-01-15T09:30:00Z",
17           "definition_id": "definition_id",
18           "environment_id": "environment_id",
19           "id": "id",
20           "updated_at": "2024-01-15T09:30:00Z",
21           "value": "value"
22         }
23       ],
24       "environment_id": "environment_id",
25       "id": "id",
26       "keys": [
27         {
28           "created_at": "2024-01-15T09:30:00Z",
29           "definition_id": "definition_id",
30           "entity_id": "entity_id",
31           "entity_type": "entity_type",
32           "environment_id": "environment_id",
33           "id": "id",
34           "key": "key",
35           "updated_at": "2024-01-15T09:30:00Z",
36           "value": "value"
37         }
38       ],
39       "name": "name",
40       "updated_at": "2024-01-15T09:30:00Z",
41       "last_seen_at": "2024-01-15T09:30:00Z",
42       "traits": {
43         "key": "value"
44       }
45     }
46   ],
47   "params": {
48     "company_id": "company_id",
49     "ids": [
50       "ids"
51     ],
52     "limit": 1,
53     "offset": 1,
54     "plan_id": "plan_id",
55     "q": "q"
56   }
57 }

Built with

1	curl https://api.schematichq.com/users \
2	-H "X-Schematic-Api-Key: <apiKey>"

1	{
2	"data": [
3	{
4	"company_memberships": [
5	{
6	"company_id": "company_id",
7	"created_at": "2024-01-15T09:30:00Z",
8	"id": "id",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"user_id": "user_id"
11	}
12	],
13	"created_at": "2024-01-15T09:30:00Z",
14	"entity_traits": [
15	{
16	"created_at": "2024-01-15T09:30:00Z",
17	"definition_id": "definition_id",
18	"environment_id": "environment_id",
19	"id": "id",
20	"updated_at": "2024-01-15T09:30:00Z",
21	"value": "value"
22	}
23	],
24	"environment_id": "environment_id",
25	"id": "id",
26	"keys": [
27	{
28	"created_at": "2024-01-15T09:30:00Z",
29	"definition_id": "definition_id",
30	"entity_id": "entity_id",
31	"entity_type": "entity_type",
32	"environment_id": "environment_id",
33	"id": "id",
34	"key": "key",
35	"updated_at": "2024-01-15T09:30:00Z",
36	"value": "value"
37	}
38	],
39	"name": "name",
40	"updated_at": "2024-01-15T09:30:00Z",
41	"last_seen_at": "2024-01-15T09:30:00Z",
42	"traits": {
43	"key": "value"
44	}
45	}
46	],
47	"params": {
48	"company_id": "company_id",
49	"ids": [
50	"ids"
51	],
52	"limit": 1,
53	"offset": 1,
54	"plan_id": "plan_id",
55	"q": "q"
56	}
57	}