List users

GET

Lists all the users in the project.

Query parameters

team_idstringOptional

Only return users who are members of the given team

limitdoubleOptional

The maximum number of items to return

cursorstringOptional

The cursor to start the result set from.

order_bystringOptional

The field to sort the results by. Defaults to signed_up_at

descbooleanOptional

Whether to sort the results in descending order. Defaults to false

querystringOptional

A search query to filter the results by. This is a free-text search that is applied to the user’s display name and primary email.

Response

Successful response

itemslist of objects

paginationobjectOptional

GET

1 curl https://api.stack-auth.com/api/v1/users

200Retrieved

1 {
2   "items": [
3     {
4       "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
5       "primary_email_verified": true,
6       "primary_email_auth_enabled": true,
7       "signed_up_at_millis": 1630000000000,
8       "last_active_at_millis": 1630000000000,
9       "primary_email": "johndoe@example.com",
10       "display_name": "John Doe",
11       "selected_team": {
12         "created_at_millis": 1630000000000,
13         "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
14         "display_name": "My Team",
15         "server_metadata": {
16           "key": "value"
17         },
18         "profile_image_url": "https://example.com/image.jpg",
19         "client_metadata": {
20           "key": "value"
21         },
22         "client_read_only_metadata": {
23           "key": "value"
24         }
25       },
26       "selected_team_id": "team-id",
27       "profile_image_url": "https://example.com/image.jpg",
28       "client_metadata": {
29         "key": "value"
30       },
31       "client_read_only_metadata": {
32         "key": "value"
33       },
34       "server_metadata": {
35         "key": "value"
36       }
37     }
38   ],
39   "pagination": {
40     "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
41   }
42 }

Built with

1	{
2	"items": [
3	{
4	"id": "3241a285-8329-4d69-8f3d-316e08cf140c",
5	"primary_email_verified": true,
6	"primary_email_auth_enabled": true,
7	"signed_up_at_millis": 1630000000000,
8	"last_active_at_millis": 1630000000000,
9	"primary_email": "johndoe@example.com",
10	"display_name": "John Doe",
11	"selected_team": {
12	"created_at_millis": 1630000000000,
13	"id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
14	"display_name": "My Team",
15	"server_metadata": {
16	"key": "value"
17	},
18	"profile_image_url": "https://example.com/image.jpg",
19	"client_metadata": {
20	"key": "value"
21	},
22	"client_read_only_metadata": {
23	"key": "value"
24	}
25	},
26	"selected_team_id": "team-id",
27	"profile_image_url": "https://example.com/image.jpg",
28	"client_metadata": {
29	"key": "value"
30	},
31	"client_read_only_metadata": {
32	"key": "value"
33	},
34	"server_metadata": {
35	"key": "value"
36	}
37	}
38	],
39	"pagination": {
40	"next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
41	}
42	}