🕢Events
Google Calendar Events
Get All Events From a Calendar
Get List of Events
GET
https://api.pyas.io/microsoft/events
Gets all events from a calendar
Query Parameters
Name | Type | Description |
---|---|---|
calendarId* | String | The id of the Google calendar |
accountId* | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
startDate | Date String | Filter events from a start date (ex: |
endDate | Date String | Filter events up to an end date (ex: |
search | String | Free text search to filter events based on the |
nextPageToken | String | Token string used to get the next page of results (paginate) |
maxResults | Integer | Max number of results to return per page |
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API key |
Get an Event By ID
Get Event by ID
GET
https://api.pyas.io/microsoft/events/:id
Gets a calendar event by id
Path Parameters
Name | Type | Description |
---|---|---|
{id}* | String | The event id |
Query Parameters
Name | Type | Description |
---|---|---|
calendarId* | String | The Google Calendar id |
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 an Event
Create Event
POST
https://api.pyas.io/microsoft/events
Creates a calendar event
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. |
calendarId* | String | The Microsoft calendar id |
eventData* | Object | The event data. See the Required Event Data Object example below. |
eventData.title* | String | The event title |
eventData.description* | String | Event description |
eventData.startDate* | DateTime | RFC3339 Timestamp |
eventData.endDate* | DateTime | RFC3339 Timestamp |
eventData.timeZone | String | Time Zone in IANA format |
eventData.location | Object | Location object - See the example Event Location Object |
eventData.attendees | Array | Array of Attendee Objects |
eventData.conferencing | Object | |
eventData.phone | String | Phone number |
eventData.phonePin | String | Optional pin if one is required to join the meeting |
eventData.recurrence | Object | Recurrence object for recurring events. See the Recurrence Object below. |
Event Data Object Example:
Event Location Object Example:
Attendee Object Example:
Event Conferencing Object:
Event Data With Zoom Conferencing Example:
Recurrence Object:
Here's an example of a recurrence object for a meeting that repeats weekly every Wednesday:
Update an Event
Update Event
PATCH
https://api.pyas.io/microsoft/events/:id
Updates an Existing Event
Path Parameters
Name | Type | Description |
---|---|---|
{id}* | String | The event 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. |
calendarId* | String | The Microsoft calendar id |
eventData* | Object | Event data object with the fields to update. See the Example Update Event Date Object below. |
Update Event Data Object Example:
Delete an Event
Delete Event
DELETE
https://api.pyas.io/microsoft/events/:id
Deletes an existing event
Path Parameters
Name | Type | Description |
---|---|---|
{id}* | String | The event ID |
Query Parameters
Name | Type | Description |
---|---|---|
accountId | String | The user's Pyas account id. This is returned when you connect an account to Pyas. |
calendarId* | String | The Microsoft calendar ID |
Headers
Name | Type | Description |
---|---|---|
x-api-key* | String | API Key |
Last updated