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.
- 200
- 401
- 404
- 429
- 500
- 503
OK
- application/json
- Schema
- Example (from schema)
- Meetings
- IDsOnly
Schema
metadata object
count integerA count of the number of meetings contained in the response.
meetings object
- oneOf
- Meetings
- MeetingIDs
Array [id stringThe meeting ID associated with this meeting.
subject stringThe subject of the meeting.
organizerName stringThe meeting organizer's full name.
organizerEmail emailThe meeting organizer's email address.
startTime date-timeThe start time of the meeting in RFC-3339 format.
endTime date-timeThe end time of the meeting in RFC-3339 format.
alias stringThe alias that can be used to join video enabled meetings.
]Array [id stringThe meeting ID associated with this meeting.
]- oneOf
{
"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"
}
]
}
{
"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"
}
]
}
{
"metadata": {
"count": 1
},
"meetings": [
{
"id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZiMi04ZdFpHRTNaR1F6WGhyZWFkLnYy"
}
]
}
The request was missing or supplied an invalid/expired bearer token
No associated mailbox was found for the requested video system
The client has made too many requests and has been throttled
An unexpected server error occurred while processing the request
The server is too busy to handle the request