Get reminders

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

Fetch all reminders for the current user.

Reminders are messages the user has scheduled to be sent in the future to themself.

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

Usage examples

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

Parameters

This endpoint does not accept any parameters.

Response

Return values

• reminders: (object)[]

  Returns all of the current user's undelivered reminders, ordered by scheduled_delivery_timestamp (ascending).

  • reminder_id: integer

    The unique ID of the reminder, which can be used to delete the reminder.

    This is different from the unique ID that the message would have after being sent.

  • type: string

    The type of the reminder. Always set to "private".

  • to: (integer)[]

    Contains the ID of the user who scheduled the reminder, and to which the reminder will be sent.

  • content: string

    The content/body of the reminder, in Zulip-flavored Markdown format.

    See Markdown message formatting for details on Zulip's HTML format.

  • rendered_content: string

    The content/body of the reminder rendered in HTML.

  • scheduled_delivery_timestamp: integer

    The UNIX timestamp for when the message will be sent by the server, in UTC seconds.

  • failed: boolean

    Whether the server has tried to send the reminder and it failed to successfully send.

    Clients that support unscheduling reminders should display scheduled messages with "failed": true with an indicator that the server failed to send the message at the scheduled time, so that the user is aware of the failure and can get the content of the scheduled message.

  • reminder_target_message_id: integer

    The ID of the message that the reminder is created for.

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": "",
    "reminders": [
        {
            "content": "Hi",
            "failed": false,
            "reminder_id": 27,
            "reminder_target_message_id": 42,
            "rendered_content": "<p>Hi</p>",
            "scheduled_delivery_timestamp": 1681662420,
            "to": [
                6
            ],
            "type": "private"
        }
    ],
    "result": "success"
}