zulip/templates/zerver/api/get-user-groups.md

35 lines
569 B
Markdown

# Get user groups
{!api-members-only.md!}
{generate_api_description(/user_groups:get)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/user_groups:get|example}
{tab|curl}
{generate_code_example(curl)|/user_groups:get|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/user_groups:get}
## Response
#### Return values
{generate_return_values_table|zulip.yaml|/user_groups:get}
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/user_groups:get|fixture(200)}