List users
Lists all the users in the project. By default, only fully onboarded users are returned. Restricted users (those who haven't completed onboarding requirements like email verification) are included if include_restricted is set to true. Anonymous users are included if include_anonymous is set to true (which also includes restricted users).
Query parameters
Only return users who are members of the given team
Only return users who are members of the given team
The maximum number of items to return
The maximum number of items to return
The cursor to start the result set from.
The cursor to start the result set from.
The field to sort the results by. Defaults to signed_up_at
The field to sort the results by. Defaults to signed_up_at
Whether to sort the results in descending order. Defaults to false
Whether to sort the results in descending order. Defaults to false
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.
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.
A comma-separated list of primary email domains to exclude from the results.
A comma-separated list of primary email domains to exclude from the results.
Whether to include anonymous users in the results. When true, also includes restricted users. Defaults to false
Whether to include anonymous users in the results. When true, also includes restricted users. Defaults to false
Whether to return only anonymous users. When true, implies include_anonymous=true. Defaults to false
Whether to return only anonymous users. When true, implies include_anonymous=true. Defaults to false
Whether to include restricted users in the results. Defaults to false
Whether to include restricted users in the results. Defaults to false
Response
Successful response
Example response
{
"items": [
{
"id": "3241a285-8329-4d69-8f3d-316e08cf140c",
"primary_email": "johndoe@example.com",
"primary_email_verified": true,
"primary_email_auth_enabled": true,
"display_name": "John Doe",
"selected_team": {
"created_at_millis": 1630000000000,
"server_metadata": {
"key": "value"
},
"id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
"display_name": "My Team",
"profile_image_url": "https://example.com/image.jpg",
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
}
},
"selected_team_id": "team-id",
"profile_image_url": "https://example.com/image.jpg",
"signed_up_at_millis": 1630000000000,
"client_metadata": {
"key": "value"
},
"client_read_only_metadata": {
"key": "value"
},
"server_metadata": {
"key": "value"
},
"last_active_at_millis": 1630000000000,
"country_code": "US",
"risk_scores": {
"sign_up": {
"bot": 0,
"free_trial_abuse": 0
}
}
}
],
"pagination": {
"next_cursor": "b3d396b8-c574-4c80-97b3-50031675ceb2"
}
}