{"_id":"59138dd4bb92601b00a4ed2a","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"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"],"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"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-10T22:01:56.845Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/meetingtypes","language":"curl"}]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":"/v1/meetingtypes"},"isReference":true,"order":57,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"_id\",\n    \"0-1\": \"*String*\",\n    \"0-2\": \"Unique ID\",\n    \"1-0\": \"userId\",\n    \"4-0\": \"name\",\n    \"5-0\": \"durationMin\",\n    \"6-0\": \"daysFromNow\",\n    \"7-0\": \"daysFromNow.start\",\n    \"8-0\": \"daysFromNow.end\",\n    \"9-0\": \"day[0-6]\",\n    \"10-0\": \"day[0,6].enabled\",\n    \"11-0\": \"day[1-5].enabled\",\n    \"13-0\": \"day[0-6].timeslots.startTime\",\n    \"14-0\": \"day[0-6].timeslots.endTime\",\n    \"15-0\": \"defaults\",\n    \"16-0\": \"defaults.title\",\n    \"17-0\": \"defaults.location\",\n    \"18-0\": \"defaults.description\",\n    \"19-0\": \"link\",\n    \"2-0\": \"createdAt\",\n    \"3-0\": \"updatedAt\",\n    \"2-1\": \"*Date*\",\n    \"3-1\": \"*Date*\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"The `_id` of the user who created the meeting type.\",\n    \"2-2\": \"When the meeting type was created.\",\n    \"3-2\": \"When the meeting type was last updated.\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"The name of the meeting type displayed in the UI. Defaults to `New meeting type`.\",\n    \"5-1\": \"*Number*\",\n    \"5-2\": \"The length of the meeting type in minutes. Defaults to `30`.\",\n    \"6-1\": \"*Object*\",\n    \"6-2\": \"The time window in which meetings of this type can be made.\",\n    \"7-1\": \"*Number*\",\n    \"7-2\": \"Minimum number of days from today to suggest meeting slots. Defaults to `1`.\",\n    \"8-1\": \"*Number*\",\n    \"8-2\": \"Maximum number of days from today to suggest meeting slots. Defaults to `21`.\",\n    \"9-1\": \"*Object*\",\n    \"9-2\": \"Availability configuration by weekday.\",\n    \"10-1\": \"*Boolean*\",\n    \"10-2\": \"Whether to allow meetings of this type to be booked on this day. Defaults to `false`.\",\n    \"11-1\": \"*Boolean*\",\n    \"11-2\": \"Whether to allow meetings of this type to be booked on this day. Defaults to `true`.\",\n    \"13-1\": \"*String*\",\n    \"14-1\": \"*String*\",\n    \"13-2\": \"Start time of timeslot during which meetings of this type can be made. Format must match \\\"HH:mm:ss\\\". Defaults to `'09:00:00'`.\",\n    \"14-2\": \"End time timeslot during which meetings of this type can be made. Format must match \\\"HH:mm:ss\\\". Defaults to `'17:00:00'`.\",\n    \"15-1\": \"*Object*\",\n    \"15-2\": \"Defaults to be used in the calendar invitation of meetings booked of this type.\",\n    \"16-1\": \"*String*\",\n    \"16-2\": \"The default calendar event title. Defaults to `''`.\",\n    \"17-1\": \"*String*\",\n    \"17-2\": \"The default calendar event location. Defaults to `''`.\",\n    \"18-1\": \"*String*\",\n    \"18-2\": \"The default calendar event description. Defaults to `''`.\",\n    \"19-1\": \"*String*\",\n    \"19-2\": \"The URL slug to use for this meeting type's calendar. Defaults to `meetingtype_<random number>`.\",\n    \"12-0\": \"day[0-6].timeslots\",\n    \"12-1\": \"*Object[]*\",\n    \"12-2\": \"The collection of timeslots for which you're available during this day. These timeslots cannot overlap, though `startTime`s and `endTimes` can match.\",\n    \"20-0\": \"buffer\",\n    \"20-1\": \"*Number*\",\n    \"20-2\": \"The amount of time in between meetings, in the range of 0 - 60 minutes.\",\n    \"21-0\": \"calendarIds\",\n    \"21-1\": \"*String[]*\",\n    \"21-2\": \"The Google Calendar IDs of the calendars on which meetings of this meeting type will be scheduled. If multiple calendars are added to a meeting type, meetings will be booked round-robin between those calendars.\",\n    \"23-0\": \"preventDoubleBooking\",\n    \"23-1\": \"*String[]*\",\n    \"23-2\": \"An array of Google Calendar IDs for which double booking will be prevented. Meetings of this meeting type can not be booked during times where there are 'busy' events on these calendars. The meeting type's `calendarId` calendar is always taken into account for double booking prevention, regardless of whether it's included in this property.\",\n    \"24-0\": \"defaultGuests\",\n    \"24-1\": \"*Object[]*\",\n    \"24-2\": \"An array of default guests to be added to meetings of this type.\",\n    \"25-0\": \"defaultGuests[].name\",\n    \"26-0\": \"defaultGuests[].email\",\n    \"27-0\": \"defaultGuests[].required\",\n    \"25-1\": \"*String*\",\n    \"25-2\": \"The name of the default guest.\",\n    \"26-1\": \"*String*\",\n    \"26-2\": \"The email of the default guest.\",\n    \"27-1\": \"*Boolean*\",\n    \"27-2\": \"Whether the default guest should be added as a required attendee of booked meetings of this type.\",\n    \"22-0\": \"roundRobinQueue\",\n    \"22-1\": \"*Number[]*\",\n    \"22-2\": \"The round robin queue. Each element value is an index of a calendar ID in the meeting type's `calendarIds`. Calendars at the beginning of this queue will be preferred for booking when someone selects an available timeslot for this meeting type where multiple calendars have availability.\"\n  },\n  \"cols\": 3,\n  \"rows\": 28\n}\n[/block]","excerpt":"","slug":"meetingtypes","type":"endpoint","title":"/meetingtypes"}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String*", "0-2": "Unique ID", "1-0": "userId", "4-0": "name", "5-0": "durationMin", "6-0": "daysFromNow", "7-0": "daysFromNow.start", "8-0": "daysFromNow.end", "9-0": "day[0-6]", "10-0": "day[0,6].enabled", "11-0": "day[1-5].enabled", "13-0": "day[0-6].timeslots.startTime", "14-0": "day[0-6].timeslots.endTime", "15-0": "defaults", "16-0": "defaults.title", "17-0": "defaults.location", "18-0": "defaults.description", "19-0": "link", "2-0": "createdAt", "3-0": "updatedAt", "2-1": "*Date*", "3-1": "*Date*", "1-1": "*String*", "1-2": "The `_id` of the user who created the meeting type.", "2-2": "When the meeting type was created.", "3-2": "When the meeting type was last updated.", "4-1": "*String*", "4-2": "The name of the meeting type displayed in the UI. Defaults to `New meeting type`.", "5-1": "*Number*", "5-2": "The length of the meeting type in minutes. Defaults to `30`.", "6-1": "*Object*", "6-2": "The time window in which meetings of this type can be made.", "7-1": "*Number*", "7-2": "Minimum number of days from today to suggest meeting slots. Defaults to `1`.", "8-1": "*Number*", "8-2": "Maximum number of days from today to suggest meeting slots. Defaults to `21`.", "9-1": "*Object*", "9-2": "Availability configuration by weekday.", "10-1": "*Boolean*", "10-2": "Whether to allow meetings of this type to be booked on this day. Defaults to `false`.", "11-1": "*Boolean*", "11-2": "Whether to allow meetings of this type to be booked on this day. Defaults to `true`.", "13-1": "*String*", "14-1": "*String*", "13-2": "Start time of timeslot during which meetings of this type can be made. Format must match \"HH:mm:ss\". Defaults to `'09:00:00'`.", "14-2": "End time timeslot during which meetings of this type can be made. Format must match \"HH:mm:ss\". Defaults to `'17:00:00'`.", "15-1": "*Object*", "15-2": "Defaults to be used in the calendar invitation of meetings booked of this type.", "16-1": "*String*", "16-2": "The default calendar event title. Defaults to `''`.", "17-1": "*String*", "17-2": "The default calendar event location. Defaults to `''`.", "18-1": "*String*", "18-2": "The default calendar event description. Defaults to `''`.", "19-1": "*String*", "19-2": "The URL slug to use for this meeting type's calendar. Defaults to `meetingtype_<random number>`.", "12-0": "day[0-6].timeslots", "12-1": "*Object[]*", "12-2": "The collection of timeslots for which you're available during this day. These timeslots cannot overlap, though `startTime`s and `endTimes` can match.", "20-0": "buffer", "20-1": "*Number*", "20-2": "The amount of time in between meetings, in the range of 0 - 60 minutes.", "21-0": "calendarIds", "21-1": "*String[]*", "21-2": "The Google Calendar IDs of the calendars on which meetings of this meeting type will be scheduled. If multiple calendars are added to a meeting type, meetings will be booked round-robin between those calendars.", "23-0": "preventDoubleBooking", "23-1": "*String[]*", "23-2": "An array of Google Calendar IDs for which double booking will be prevented. Meetings of this meeting type can not be booked during times where there are 'busy' events on these calendars. The meeting type's `calendarId` calendar is always taken into account for double booking prevention, regardless of whether it's included in this property.", "24-0": "defaultGuests", "24-1": "*Object[]*", "24-2": "An array of default guests to be added to meetings of this type.", "25-0": "defaultGuests[].name", "26-0": "defaultGuests[].email", "27-0": "defaultGuests[].required", "25-1": "*String*", "25-2": "The name of the default guest.", "26-1": "*String*", "26-2": "The email of the default guest.", "27-1": "*Boolean*", "27-2": "Whether the default guest should be added as a required attendee of booked meetings of this type.", "22-0": "roundRobinQueue", "22-1": "*Number[]*", "22-2": "The round robin queue. Each element value is an index of a calendar ID in the meeting type's `calendarIds`. Calendars at the beginning of this queue will be preferred for booking when someone selects an available timeslot for this meeting type where multiple calendars have availability." }, "cols": 3, "rows": 28 } [/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 }}