mirror of https://github.com/zulip/zulip.git
39 lines
799 B
Markdown
39 lines
799 B
Markdown
|
# 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)}
|