zulip/templates/zerver/api/check-narrow-matches.md

628 B

Check messages match narrow

{generate_api_description(/messages/matches_narrow:get)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/messages/matches_narrow:get|example}

{tab|curl}

{generate_code_example(curl)|/messages/matches_narrow:get|example}

{end_tabs}

Arguments

{generate_api_arguments_table|zulip.yaml|/messages/matches_narrow:get}

Response

Return values

{generate_return_values_table|zulip.yaml|/messages/matches_narrow:get}

Example response

A typical successful JSON response may look like:

{generate_code_example|/messages/matches_narrow:get|fixture(200)}