Get linkifiers

GET https://zulip.fairsharing.org/api/v1/realm/linkifiers

List all of an organization's configured linkifiers, regular expression patterns that are automatically linkified when they appear in messages and topics.

Changes: New in Zulip 4.0 (feature level 54). On older versions, a similar GET /realm/filters endpoint was available with each entry in a [pattern, url_format, id] tuple format.

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Fetch all the linkifiers in this organization.
result = client.call_endpoint(
    url="/realm/linkifiers",
    method="GET",
)
print(result)

curl -sSX GET -G https://zulip.fairsharing.org/api/v1/realm/linkifiers \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

• linkifiers: (object)[]

  An ordered array of objects, where each object describes a linkifier.

  Clients should always process linkifiers in the order given; this is important if the realm has linkifiers with overlapping patterns. The order can be modified using PATCH /realm/linkifiers.

  • pattern: string

    The string regex pattern which represents the pattern that should be linkified by this linkifier.

  • url_template: string

    The RFC 6570 compliant URL template to be used for linkifying matches.

    Changes: New in Zulip 7.0 (feature level 176). This replaced url_format, which contained a URL format string.

  • id: integer

    The ID of the linkifier.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "linkifiers": [
        {
            "id": 1,
            "pattern": "#(?P<id>[0-9]+)",
            "url_template": "https://github.com/zulip/zulip/issues/{id}"
        }
    ],
    "msg": "",
    "result": "success"
}