Sign in
users

Search users

Get a list of users based on search criteria provided in the request body. Searches are typically done against username, full name, nickname and email unless otherwise configured by the server.

Permissions

Requires an active session and read_channel and/or view_team permissions for any channels or teams specified in the request body.

post/api/v4/users/search

Request body

termstring required

The term to match against username, full name, nickname and email

team_idstring

If provided, only search users on this team

not_in_team_idstring

If provided, only search users not on this team

in_channel_idstring

If provided, only search users in this channel

not_in_channel_idstring

If provided, only search users not in this channel. Must specifiy team_id when using this option

in_group_idstring

If provided, only search users in this group. Must have manage_system permission.

group_constrainedboolean

When used with not_in_channel_id or not_in_team_id, returns only the users that are allowed to join the channel or team based on its group constrains.

allow_inactiveboolean

When true, include deactivated users in the results

without_teamboolean

Set this to true if you would like to search for users that are not on a team. This option takes precendence over team_id, in_channel_id, and not_in_channel_id.

limitinteger

The maximum number of users to return in the results

Defaults to 100 if not provided.

Response

User list retrieval successful

idstring
create_atinteger

The time in milliseconds a user was created

update_atinteger

The time in milliseconds a user was last updated

delete_atinteger

The time in milliseconds a user was deleted

usernamestring
first_namestring
last_namestring
nicknamestring
emailstring
email_verifiedboolean
auth_servicestring
rolesstring
localestring
propsobject
last_password_updateinteger
last_picture_updateinteger
failed_attemptsinteger
mfa_activeboolean
terms_of_service_idstring

ID of accepted terms of service, if any. This field is not present if empty.

terms_of_service_create_atinteger

The time in milliseconds the user accepted the terms of service

Changes

No recorded changes to this endpoint across all 1 revision of this API.