GET /users

Retrieve details on users in the organization.

By default, returns all accessible users in the organization. The user_ids query parameter can be used to limit the results to a specific set of user IDs.

Optionally includes values of custom profile fields.

You can also fetch details on a single user.

Changes: In Zulip 12.0 (feature level 437), fixed a bug dating to feature level 232, which caused guest users to receive fake backwards-compatibility users in the format intended for clients using POST /register without the user_list_incomplete client capability.

This endpoint did not support unauthenticated access in organizations using the public access option prior to Zulip 11.0 (feature level 387).

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Query parameters

Name Type Required Description

Name	Type	Required	Description
`include_custom_profile_fields`	Boolean	No	Whether the client wants custom profile field data to be included in the response. Changes: New in Zulip 2.1.0. Previous versions do not offer these data via the API. Default value: false
`user_ids`		No	Limits the results to the specified user IDs. If not provided, the server will return all accessible users in the organization. Changes: New in Zulip 11.0 (feature level 384).
`client_gravatar`	Boolean	No	Whether the client supports computing gravatars URLs. If enabled, `avatar_url` will be included in the response only if there is a Zulip avatar, and will be `null` for users who are using gravatar as their avatar. This option significantly reduces the compressed size of user data, since gravatar URLs are long, random strings and thus do not compress well. The `client_gravatar` field is set to `true` if clients can compute their own gravatars. Changes: The default value of this parameter was `false` prior to Zulip 5.0 (feature level 92). Default value: true

include_custom_profile_fields

Boolean

Whether the client wants custom profile field data to be included in the response.

Changes: New in Zulip 2.1.0. Previous versions do not offer these data via the API.

Default value: false

user_ids

Limits the results to the specified user IDs. If not provided, the server will return all accessible users in the organization.

Changes: New in Zulip 11.0 (feature level 384).

client_gravatar

Boolean

Whether the client supports computing gravatars URLs. If enabled, avatar_url will be included in the response only if there is a Zulip avatar, and will be null for users who are using gravatar as their avatar. This option significantly reduces the compressed size of user data, since gravatar URLs are long, random strings and thus do not compress well. The client_gravatar field is set to true if clients can compute their own gravatars.

Changes: The default value of this parameter was false prior to Zulip 5.0 (feature level 92).

Default value: true

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.