{"_id":"5977db5ffe1b3c001a79aad9","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb","5a31c9409a6f2000125c079f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API: Access your Mixmax data"},"user":"5588b847f6c18d0d005bba01","githubsync":"","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-25T23:59:27.201Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":"/v1/meetinginvites"},"isReference":true,"order":55,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"userId\",\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The `_id` of the user who created the meeting type.\",\n    \"0-1\": \"String\",\n    \"1-0\": \"creationDate\",\n    \"1-1\": \"Double\",\n    \"1-2\": \"Timestamp represented in ms.\",\n    \"2-0\": \"location\",\n    \"2-2\": \"The meeting location.\",\n    \"2-1\": \"String\",\n    \"3-0\": \"description\",\n    \"3-2\": \"A description of the event.\",\n    \"3-1\": \"String\",\n    \"4-0\": \"title\",\n    \"4-2\": \"The event's title on a calendar.\",\n    \"4-1\": \"String\",\n    \"5-0\": \"timezone\",\n    \"5-2\": \"The timezone of the event, e.g. America/Los_Angeles\",\n    \"5-1\": \"String\",\n    \"6-2\": \"The name of the calendar the invite is on.\",\n    \"6-0\": \"calendarName\",\n    \"6-1\": \"String\",\n    \"7-0\": \"locale\",\n    \"7-2\": \"The user's locale, e.g. 'en'\",\n    \"7-1\": \"String\",\n    \"8-0\": \"guestsCanModify\",\n    \"8-2\": \"Whether invited guests can modify the event.\",\n    \"8-1\": \"Boolean\",\n    \"9-0\": \"timeslots\",\n    \"9-2\": \"Array of timeslots specified by the meeting invite creator. Children have ISO dates 'start' and 'end'.\",\n    \"9-1\": \"Array of Objects\",\n    \"14-0\": \"allowDoubleBookings\",\n    \"14-1\": \"Boolean\",\n    \"14-2\": \"Whether to allow double bookings.\",\n    \"15-0\": \"additionalGuests\",\n    \"15-1\": \"Array of Objects\",\n    \"15-2\": \"Array of guests to add to the calendar event as ‘accepted’ once the event is created. Guest objects have 'name' and 'email'.\",\n    \"16-0\": \"meetingTypeId\",\n    \"16-2\": \"The ID of the meetingType the invite was created from.\",\n    \"16-1\": \"String\",\n    \"17-0\": \"createdById\",\n    \"17-1\": \"String\",\n    \"17-2\": \"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`.\",\n    \"18-0\": \"customFields\",\n    \"18-1\": \"Object[]\",\n    \"18-2\": \"Custom fields filled out by the meeting booker during booking.\",\n    \"19-0\": \"customFields[].label\",\n    \"19-1\": \"String\",\n    \"19-2\": \"The custom field label used to denote the custom field.\",\n    \"20-0\": \"customFields[].required\",\n    \"20-1\": \"Boolean\",\n    \"20-2\": \"Whether the custom field is required to be completed for meeting booking.\",\n    \"10-0\": \"timeslots[].events\",\n    \"10-1\": \"Object[]\",\n    \"10-2\": \"Events booked for a timeslot.\",\n    \"11-0\": \"timeslots[].events[].id\",\n    \"11-2\": \"The Google Calendar event ID.\",\n    \"11-1\": \"String\",\n    \"12-0\": \"timeslots[].events[].customFields\",\n    \"12-1\": \"String[]\",\n    \"12-2\": \"Custom field responses entered by the meeting guest with the same order as this `meetinginvite`'s root `customFields` property.\",\n    \"13-0\": \"timeslots[].events[].guest\",\n    \"13-1\": \"Object\",\n    \"13-2\": \"The guest of the booked meeting.\",\n    \"21-0\": \"integrations\",\n    \"22-0\": \"integrations.zoom\",\n    \"22-1\": \"Boolean\",\n    \"22-2\": \"If enabled, a Zoom meeting url will be prepended to the location field of an event booked through this meeting invite. \\n\\nRequires that the user grants access to their Zoom account.\",\n    \"21-1\": \"Object\",\n    \"21-2\": \"Flags to enable integrations with various products.\"\n  },\n  \"cols\": 3,\n  \"rows\": 23\n}\n[/block]","excerpt":"Get a list of meeting invites.","slug":"meetinginvites-1","type":"endpoint","title":"/meetinginvites"}

get/meetinginvites

Get a list of meeting invites.

Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:parameters] { "data": { "0-0": "userId", "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-2": "The `_id` of the user who created the meeting type.", "0-1": "String", "1-0": "creationDate", "1-1": "Double", "1-2": "Timestamp represented in ms.", "2-0": "location", "2-2": "The meeting location.", "2-1": "String", "3-0": "description", "3-2": "A description of the event.", "3-1": "String", "4-0": "title", "4-2": "The event's title on a calendar.", "4-1": "String", "5-0": "timezone", "5-2": "The timezone of the event, e.g. America/Los_Angeles", "5-1": "String", "6-2": "The name of the calendar the invite is on.", "6-0": "calendarName", "6-1": "String", "7-0": "locale", "7-2": "The user's locale, e.g. 'en'", "7-1": "String", "8-0": "guestsCanModify", "8-2": "Whether invited guests can modify the event.", "8-1": "Boolean", "9-0": "timeslots", "9-2": "Array of timeslots specified by the meeting invite creator. Children have ISO dates 'start' and 'end'.", "9-1": "Array of Objects", "14-0": "allowDoubleBookings", "14-1": "Boolean", "14-2": "Whether to allow double bookings.", "15-0": "additionalGuests", "15-1": "Array of Objects", "15-2": "Array of guests to add to the calendar event as ‘accepted’ once the event is created. Guest objects have 'name' and 'email'.", "16-0": "meetingTypeId", "16-2": "The ID of the meetingType the invite was created from.", "16-1": "String", "17-0": "createdById", "17-1": "String", "17-2": "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`.", "18-0": "customFields", "18-1": "Object[]", "18-2": "Custom fields filled out by the meeting booker during booking.", "19-0": "customFields[].label", "19-1": "String", "19-2": "The custom field label used to denote the custom field.", "20-0": "customFields[].required", "20-1": "Boolean", "20-2": "Whether the custom field is required to be completed for meeting booking.", "10-0": "timeslots[].events", "10-1": "Object[]", "10-2": "Events booked for a timeslot.", "11-0": "timeslots[].events[].id", "11-2": "The Google Calendar event ID.", "11-1": "String", "12-0": "timeslots[].events[].customFields", "12-1": "String[]", "12-2": "Custom field responses entered by the meeting guest with the same order as this `meetinginvite`'s root `customFields` property.", "13-0": "timeslots[].events[].guest", "13-1": "Object", "13-2": "The guest of the booked meeting.", "21-0": "integrations", "22-0": "integrations.zoom", "22-1": "Boolean", "22-2": "If enabled, a Zoom meeting url will be prepended to the location field of an event booked through this meeting invite. \n\nRequires that the user grants access to their Zoom account.", "21-1": "Object", "21-2": "Flags to enable integrations with various products." }, "cols": 3, "rows": 23 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}