2017-12-30 04:09:58 +01:00
|
|
|
# Get all users
|
|
|
|
|
2020-04-28 20:00:46 +02:00
|
|
|
{generate_api_description(/users:get)}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
|
|
|
## Usage examples
|
|
|
|
|
2018-09-17 16:27:32 +02:00
|
|
|
{start_tabs}
|
|
|
|
{tab|python}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
2018-06-18 19:43:40 +02:00
|
|
|
{generate_code_example(python)|/users:get|example}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
2018-09-17 16:27:32 +02:00
|
|
|
{tab|js}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
|
|
|
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
|
2020-06-21 22:51:47 +02:00
|
|
|
|
|
|
|
{generate_code_example(javascript)|/users:get|example}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
2018-09-17 16:27:32 +02:00
|
|
|
{tab|curl}
|
|
|
|
|
2019-10-11 14:51:18 +02:00
|
|
|
{generate_code_example(curl, include=[""])|/users:get|example}
|
2018-09-17 16:27:32 +02:00
|
|
|
|
|
|
|
You may pass the `client_gravatar` query parameter as follows:
|
|
|
|
|
2019-10-11 14:51:18 +02:00
|
|
|
{generate_code_example(curl)|/users:get|example}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
2018-09-17 16:27:32 +02:00
|
|
|
{end_tabs}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
2020-06-18 15:35:25 +02:00
|
|
|
## Parameters
|
2018-01-20 22:03:05 +01:00
|
|
|
|
2020-06-18 15:35:25 +02:00
|
|
|
**Note**: The following parameters are all URL query parameters.
|
2018-01-20 22:03:05 +01:00
|
|
|
|
2018-06-18 19:43:40 +02:00
|
|
|
{generate_api_arguments_table|zulip.yaml|/users:get}
|
2018-01-20 22:03:05 +01:00
|
|
|
|
2017-12-30 04:09:58 +01:00
|
|
|
## Response
|
|
|
|
|
|
|
|
#### Return values
|
|
|
|
|
2020-05-20 11:57:57 +02:00
|
|
|
{generate_return_values_table|zulip.yaml|/users:get}
|
2017-12-30 04:09:58 +01:00
|
|
|
|
|
|
|
#### Example response
|
|
|
|
|
|
|
|
A typical successful JSON response may look like:
|
|
|
|
|
2018-06-18 19:43:40 +02:00
|
|
|
{generate_code_example|/users:get|fixture(200)}
|