Get meetings

GET https://connect.suryojasvi.com/api/v1/meetings

Get the meetings in the conversations the user can see -- those made, or scheduled to start, in the last 30 days, and those still to come -- the most recently made first, at most 100.

A meeting is listed only while its card is in a conversation the user can see; one whose card has been deleted is not.

Changes: New in Zulip 13.0 (feature level ZF-0c68d1).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Zulip users and bots.

curl -sSX GET -G https://connect.suryojasvi.com/api/v1/meetings \
    -u EMAIL_ADDRESS:API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

  • meetings: (object)[]

    The meetings, the most recently made first. * meeting_id: integer

    The meeting's ID.
    
    • message_id: integer

      The ID of the meeting's card. * title: string

      The meeting's title. * creator_id: integer

      The ID of the user who made the meeting, who hosts it.

    • stream_id: integer | null

      The channel the meeting's card is in, or null if it is in a direct message conversation.

    • topic: string | null

      The topic the meeting's card is in, or null if it is in a direct message conversation.

    • user_ids: (integer)[]

      The IDs of the users in the direct message conversation the meeting's card is in, the user included, sorted; or null if it is in a channel.

    • scheduled_start: integer | null

      When a scheduled meeting is to start, as a UNIX timestamp in seconds, or null.

    • scheduled_end: integer | null

      When a scheduled meeting is to end, as a UNIX timestamp in seconds, or null if not said.

    • started_at: integer | null

      When the meeting last started, as a UNIX timestamp in seconds, or null if nobody has joined it yet.

    • ended_at: integer | null

      When the meeting last ended, as a UNIX timestamp in seconds, or null if it has not ended.

    • date_created: integer

      When the meeting was made, as a UNIX timestamp in seconds.

    • participants: (object)[]

      Who is in the meeting now. * id: string

      Their place in the meeting's room.
      
      • name: string

        Their name, as they joined. * user_id: integer | null

        Their user ID, or null for a guest from outside the organization.

    • join_url: string

      Where someone from the organization joins the meeting, signed in.

    • guest_url: string

      The meeting's link for someone outside the organization, who joins as a guest.

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:

{
    "meetings": [
        {
            "creator_id": 10,
            "ended_at": null,
            "guest_url": "https://meet.example.com/meet-3f2a9c1b7d4e5f60a1b2c3d4",
            "join_url": "/meet/meet-3f2a9c1b7d4e5f60a1b2c3d4",
            "meeting_id": 1,
            "message_id": 45,
            "participants": [],
            "scheduled_end": 1791401800,
            "scheduled_start": 1791400000,
            "started_at": null,
            "stream_id": 1,
            "title": "Weekly sync",
            "topic": "planning",
            "user_ids": null
        }
    ],
    "msg": "",
    "result": "success"
}