🕢Meetings
Zoom Meetings
Get All Meetings
Get List of Meetings
GET
https://api.pyas.io/zoom/meetings
Gets all meetings for an account
Query Parameters
Name | Type | Description |
---|---|---|
accountId* | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
startDate | Date String | Filter meetings from a start date (ex: |
endDate | Date String | Filter meetings up to an end date (ex: |
nextPageToken | String | Token string used to get the next page of results (paginate) - This token expires after 15 minutes |
maxResults | Integer | Max number of results to return per page |
type | String | Type of meeting. Possible values are:
|
pageNumber | Integer | The page number of the current page in the returned records. |
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API key |
Get an Event By ID
Get Event by ID
GET
https://api.pyas.io/zoom/meetings/:id
Gets a calendar event by id
Path Parameters
Name | Type | Description |
---|---|---|
{id}* | String | The meeting id |
Query Parameters
Name | Type | Description |
---|---|---|
accountId* | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API key |
Create a Meeting
Create Meeting
POST
https://api.pyas.io/zoom/meetings
Creates a new Zoom Meeting
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API key |
Request Body
Name | Type | Description |
---|---|---|
accountId* | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
meetingData* | Object | The event data. See the Required Meeting Data Object example below. |
meetingData.title* | String | The meeting title/topic |
meetingData.description* | String | Meeting description/agenda |
meetingData.startDate* | DateTime | RFC3339 Timestamp |
meetingData.timeZone | String | Time Zone in IANA format. Only used for scheduled or recurring meetings with a fixed time |
meetingData.attendees | Array | Array of Attendee Objects |
meetingData.recurrence | Object | Recurrence object for recurring events. See the Recurrence Object below. |
meetingData.duration | Integer | The meeting duration in minutes. Only used for scheduled meetings. Defaults to 30 |
meetingData.waitingRoom | Boolean | Whether to enable or disable the waiting room |
meetingData.type* | Integer | Type of meeting:
|
Meeting Data Object
Attendee Object Example:
Recurrence Object:
Here's an example of a recurrence object for a meeting that repeats weekly every Wednesday:
Update a Meeting
Update Meeting
PATCH
https://api.pyas.io/zoom/meetings/:id
Updates an Existing Meeting
Path Parameters
Name | Type | Description |
---|---|---|
{id}* | String | The meeting ID |
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API Key |
Request Body
Name | Type | Description |
---|---|---|
accountId* | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
meetingData* | Object | Event data object with the fields to update. See the Example Update Meeting Data Object below. |
Update Meeting Data Object Example:
Delete a Meeting
Delete Meeting
DELETE
https://api.pyas.io/zoom/meetings/:id
Deletes an existing meeting
Path Parameters
Name | Type | Description |
---|---|---|
{id}* | String | The meeting ID |
Query Parameters
Name | Type | Description |
---|---|---|
accountId* | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API Key |
Last updated