mirror of
https://github.com/zulip/zulip.git
synced 2026-07-12 21:04:41 +08:00
dfafdda9b3
Add new rest api endpoint GET users/{email} for looking up a user by
email, which is useful especially for corporate API applications that
might already have a user's email address.
Fixes #14302.
799 B
799 B
Get a user by email
{generate_api_description(/users/{email}:get)}
Usage examples
{start_tabs} {tab|python}
{generate_code_example(python)|/users/{email}:get|example}
{tab|curl}
{generate_code_example(curl, include=[""])|/users/{email}:get|example}
You may pass the client_gravatar or include_custom_profile_fields query parameter as follows:
{generate_code_example(curl)|/users/{email}:get|example}
{end_tabs}
Parameters
Note: The following parameters are all URL query parameters.
{generate_api_arguments_table|zulip.yaml|/users/{email}:get}
Response
Return values
{generate_return_values_table|zulip.yaml}|/users/{email}:get}
Example response
A typical successful JSON response may look like:
{generate_code_example|/users/{email}:get|fixture(200)}