Get all navigation views

GET https://chat.zulip.org/api/v1/navigation_views

Fetch all configured custom navigation views for the current user.

Changes: New in Zulip 11.0 (feature level 390).

Usage examples

#!/usr/bin/env python3

import zulip

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

# Get all navigation views for the user
result = client.call_endpoint(
    url="navigation_views",
    method="GET",
)
print(result)

curl -sSX GET -G https://chat.zulip.org/api/v1/navigation_views \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

• navigation_views: (object)[]

  An array of dictionaries containing the user's navigation views.

  • fragment: string

    A unique identifier for the view, used to determine navigation behavior when clicked.

    Clients should use this value to navigate to the corresponding URL hash.

  • is_pinned: boolean

    Determines whether the view appears directly in the sidebar or is hidden in the "More Views" menu.

    • true - Pinned and visible in the sidebar.
    • false - Hidden and accessible via the "More Views" menu.

  • name: string | null

    The user-facing name for custom navigation views. Omit this field for built-in views.

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:

{
    "msg": "",
    "navigation_views": [
        {
            "fragment": "narrow/is/alerted",
            "is_pinned": false,
            "name": "Alert Words"
        }
    ],
    "result": "success"
}