Get meetings

GET 
/v1/meetings

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

Request

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

200

OK

application/json

Schema

Schema

metadata object

count integer

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

meetings object
oneOf
Meetings
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.
]
MeetingIDs
Array [
id string
The meeting ID associated with this meeting.
]

Example (from schema)

{
  "metadata": {
    "count": 1
  },
  "meetings": [
    null
  ]
}

Meetings

{
  "metadata": {
    "count": 1
  },
  "meetings": [
    {
      "id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy",
      "subject": "My important meeting",
      "organizerName": "Example user",
      "organizerEmail": "example.user@example.com",
      "startTime": "2021-12-21T09:00:00Z",
      "endTime": "2021-12-21T10:00:00Z",
      "alias": "name@example.com"
    }
  ]
}

IDsOnly

{
  "metadata": {
    "count": 1
  },
  "meetings": [
    {
      "id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy"
    }
  ]
}

401

The request was missing or supplied an invalid/expired bearer token

404

No associated mailbox was found for the requested video system

429

The client has made too many requests and has been throttled

500

An unexpected server error occurred while processing the request

503

The server is too busy to handle the request

Loading...