The user's Pyas account id. This is returned when you connect an account to Pyas.
startDate
Timestamp/Date String
Filter events by start date
(ex: 01-01-2022)
endDate
Timestamp/Date String
Filter events by end time
(ex: 01-01-2023)
search
String
Free text search terms to find events that match these terms in the following fields: summary, description, location, attendee's displayName, attendee's email.
nextPageToken
String
Token string used to get the next page of results (paginate)
maxResults
Integer
Max number of results to return per page
syncToken
String
Token obtained from the nextSyncToken field returned on the last page of results
eventTypes
String
Event types to return. Acceptable values are:
"birthday": Special all-day events with an annual recurrence.
"default": Regular events.
"focusTime": Focus time events.
"fromGmail": Events from Gmail.
"outOfOffice": Out of office events.
"workingLocation": Working location events.
iCalUID
String
Use this if you want to search for an event by its iCalendar ID.
maxAttendees
Integer
The maximum number of attendees to include in the response.
orderBy
String
The order of the events returned in the result. Acceptable values are:
"startTime": Order by the start date/time (ascending). This is only available when querying single events (i.e. the parameter singleEvents is True)
"updated": Order by last modification time (ascending).
privateExtendedProperty
String
Extended properties constraint specified as propertyName=value. Matches only private properties.
sharedExtendedProperty
String
Extended properties constraint specified as propertyName=value. Matches only shared properties
showDeleted
Boolean
Whether to include deleted events (with status = "cancelled") in the result.
singleEvents
Boolean
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.
timeZone
String
Time zone used in the response. Optional. The default is the time zone of the calendar.
showHiddenInvitations
Boolean
Whether to include hidden invitations in the result. Optional. The default is False.
updatedMin
Timestamp/Date String
Filter events by last modified/updated time
filters
JSON
Query filteres provided in JSON key-value pairs.
ex: {"singleEvents": true} Note: This is supported, but not recommended.
{
"errors": [
{
"msg": "calendar id is required",
"param": "calendarId",
"location": "query"
},
{
"msg": "calendar id must be a string",
"param": "calendarId",
"location": "query"
}
]
}
{
"provider": string, // Required. Possible values: "google-meet", "zoom"
"accountId": string, // Optional. - Only Required if provider = zoom. This is the ID for the connected Zoom account in Pyas.
"waitingRoom": boolean // Optional. - Only Required if provider = zoom
}
{
type: string // daily, weekly, or monthly - Required.
interval: number|string // Define the interval at which the meeting should recur. (ex. 2 for every two weeks with type of weekly) - Required.
startDate?: string // the dateTime of when the recurring meeting will start (used for Microsoft Outlook only)
endDate?: string // the dateTime of when the recurring meeting will end
dayOfMonth?: number|string // day of month for a monthly meeting. 1 - 31 (ex. 15 for the 15th of every month)
daysOfWeek?: Array<string> // days of week for a weekly meeting type (ex. ['monday', 'wednesday'])
month?: number|string // The month in which the event occurs. This is a number from 1 to 12. (Microsoft and Google only)
}
Here's an example of a recurrence object for a meeting that repeats weekly every Wednesday:
Note: eventData.meta should only be used to include fields that aren't already a part of the standard body fields in the eventData object. Also note that there won't be a meta field on the event body/data returned in the response. Instead, any properties/fields that were sent in eventData.meta will be spread onto the event body that gets returned in the response.
Recurrence object for recurring events. See the below.
More request body fields from the official Google Docs can be found here:
Simply include the extra fields you need to eventData.meta. If you need to store custom properties to the event, you can do so by adding a nested object to eventData.meta. Please see the .
Event data object with the fields to update. See the below.
Optional. Additional fields to include in the update request. See the above.