Skip to main content

Get meetings

GET /v1/meetings

Get the next meetings for the video system's registered mailbox calendar, ordered by the soonest start time.

Query Parameters
  • startTime date-time

    Optionally filters the meetings contained in the response. Must be used in conjunction with endTime. Requires an RFC-3339 formatted date-time. May be omitted.

  • endTime date-time

    Optionally filters the meetings contained in the response. Must be used in conjunction with startTime. Requires an RFC-3339 formatted date-time. May be omitted.

  • limit integer

    Possible values: >= 1 and <= 100

    Optionally limits how many many meetings can be contained in the response. Defaults to 10 if omitted.

  • idsOnly any

    Optionally limits request to only get meeting IDs. May be omitted.

Header Parameters
  • x-trackingid uuid

    A recommended tracking ID that can be supplied to Pexip support to troubleshoot a request.

  • user-agent string

    A recommended User Agent that can be used by Pexip to identify the client sending the request.

Responses

OK

Schema
  • metadata object
  • count integer

    A count of the number of meetings contained in the response.

  • meetings object
  • oneOf
  • Array [
  • id string

    The meeting ID associated with this meeting.

  • subject string

    The subject of the meeting.

  • organizerName string

    The meeting organizer's full name.

  • organizerEmail email

    The meeting organizer's email address.

  • startTime date-time

    The start time of the meeting in RFC-3339 format.

  • endTime date-time

    The end time of the meeting in RFC-3339 format.

  • alias string

    The alias that can be used to join video enabled meetings.

  • ]
Loading...