List users | Stack Auth Documentation

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

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 "is_anonymous": true, 10 "primary_email": "johndoe@example.com", 11 "display_name": "John Doe", 12 "selected_team": { 13 "created_at_millis": 1630000000000, 14 "id": "ad962777-8244-496a-b6a2-e0c6a449c79e", 15 "display_name": "My Team", 16 "server_metadata": { 17 "key": "value" 18 }, 19 "profile_image_url": "https://example.com/image.jpg", 20 "client_metadata": { 21 "key": "value" 22 }, 23 "client_read_only_metadata": { 24 "key": "value" 25 } 26 }, 27 "selected_team_id": "team-id", 28 "profile_image_url": "https://example.com/image.jpg", 29 "client_metadata": { 30 "key": "value" 31 }, 32 "client_read_only_metadata": { 33 "key": "value" 34 }, 35 "server_metadata": { 36 "key": "value" 37 } 38 } 39 ], 40 "pagination": { 41 "next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2" 42 } 43 }

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 id (exact-match only), display name and primary email.

Response

Successful response

itemslist of objects

paginationobjectOptional