zulip/templates/zerver/api/get-subscription-status.md

Get user subscription status

{generate_api_description(/users/{user_id}/subscriptions/{stream_id}:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/users/{user_id}/subscriptions/{stream_id}:get|example}

{tab|curl}

{generate_code_example(curl)|/users/{user_id}/subscriptions/{stream_id}:get|example}

{end_tabs}

Arguments

{generate_api_arguments_table|zulip.yaml|/users/{user_id}/subscriptions/{stream_id}:get}

Response

Example response

A typical successful JSON response may look like:

{generate_code_example|/users/{user_id}/subscriptions/{stream_id}:get|fixture(200)}