zulip/templates/zerver/api/list-linkifiers.md

37 lines
795 B
Markdown
Raw Normal View History

# List linkifiers
2018-08-14 03:10:37 +02:00
{generate_api_description(/realm/filters:get)}
2018-08-14 03:10:37 +02:00
## Usage examples
{start_tabs}
{tab|python}
2018-08-14 03:10:37 +02:00
{generate_code_example(python)|/realm/filters:get|example}
{tab|curl}
2018-08-14 03:10:37 +02:00
{generate_code_example(curl)|/realm/filters:get|example}
2018-08-14 03:10:37 +02:00
{end_tabs}
2018-08-14 03:10:37 +02:00
## Arguments
{generate_api_arguments_table|zulip.yaml|/realm/filters:get}
## Response
#### Return values
* `filters`: An array of tuples, each representing one of the
linkifiers set up in the organization. Each of these tuples contain the
pattern, the formatted URL and the filter's ID, in that order. See
the [Create linkifiers](/api/add-linkifiers) article for details on what
each field means.
2018-08-14 03:10:37 +02:00
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/realm/filters:get|fixture(200)}