get https://example.com/v1/meetinginvites
Get a list of meeting invites.
Parameter | Type | Description |
---|---|---|
userId | String | The _id of the user who created the meeting type. |
creationDate | Double | Timestamp represented in ms. |
location | String | The meeting location. |
description | String | A description of the event. |
title | String | The event's title on a calendar. |
timezone | String | The timezone of the event, e.g. America/Los_Angeles |
calendarName | String | The name of the calendar the invite is on. |
locale | String | The user's locale, e.g. 'en' |
guestsCanModify | Boolean | Whether invited guests can modify the event. |
timeslots | Array of Objects | Array of timeslots specified by the meeting invite creator. Children have ISO dates 'start' and 'end'. |
timeslots[].events | Object[] | Events booked for a timeslot. |
timeslots[].events[].id | String | The Google Calendar event ID. |
timeslots[].events[].customFields | String[] | Custom field responses entered by the meeting guest with the same order as this meetinginvite 's root customFields property. |
timeslots[].events[].guest | Object | The guest of the booked meeting. |
allowDoubleBookings | Boolean | Whether to allow double bookings. |
additionalGuests | Array of Objects | Array of guests to add to the calendar event as ‘accepted’ once the event is created. Guest objects have 'name' and 'email'. |
meetingTypeId | String | The ID of the meetingType the invite was created from. |
createdById | String | The ID of the user who organized this meeting. This will be set and different from userId if someone sends availability on behalf of a teammate via /meeting . |
customFields | Object[] | Custom fields filled out by the meeting booker during booking. |
customFields[].label | String | The custom field label used to denote the custom field. |
customFields[].required | Boolean | Whether the custom field is required to be completed for meeting booking. |
integrations | Object | Flags to enable integrations with various products. |
integrations.zoom | Boolean | If enabled, a Zoom meeting url will be prepended to the location field of an event booked through this meeting invite. Requires that the user grants access to their Zoom account. |