{"__v":2,"_id":"58100a380d8f811900f324eb","category":{"__v":0,"_id":"57f53fb368a53b2000e03f0f","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","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","version":{"__v":14,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-26T01:43:20.713Z","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/availability","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n  \"results\": [\n    {\n      \"_id\": \"581007cabde0d43ed7f87601\",\n      \"creationDate\": 1477445578709,\n      \"userId\": \"kZYPwDDiGPTfQDj5n\",\n      \"location\": \"San Francisco, CA\",\n      \"description\": \"Let's meet for coffee!\",\n      \"title\": \"My Meeting\",\n      \"timezone\": \"America/Los_Angeles\",\n      \"calendarId\": \"hello:::at:::mixmax.com\",\n      \"calendarName\": \"hello@mixmax.com\",\n      \"guestsCanModify\": true,\n      \"timeslots\": [\n        {\n          \"start\": \"2016-10-26T02:00:00.000Z\",\n          \"end\": \"2016-10-26T02:30:00.000Z\",\n          \"events\": [\n            {\n              \"guest\": {\n                \"name\": \"Mixmax\",\n                \"email\": \"hello@mixmax.com\"\n              },\n              \"id\": \"q5pfcj8d6o18m7rgog6t5sin1s\"\n            }\n          ]\n        },\n        {\n          \"start\": \"2016-10-26T02:30:00.000Z\",\n          \"end\": \"2016-10-26T03:00:00.000Z\"\n        },\n        {\n          \"start\": \"2016-10-26T03:00:00.000Z\",\n          \"end\": \"2016-10-26T03:30:00.000Z\"\n        }\n      ],\n      \"allowDoubleBookings\": false,\n      \"additionalGuests\": []\n    }\n  ]\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/v1/availability"},"isReference":true,"order":1,"body":"This API returns a list of objects created each time you've proposed your availability using Mixmax.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"_id\",\n    \"0-1\": \"*String* \",\n    \"1-0\": \"creationDate\",\n    \"1-1\": \"*Timestamp* \",\n    \"2-0\": \"userId\",\n    \"2-1\": \"*String* \",\n    \"3-0\": \"location\",\n    \"3-1\": \"*String* \",\n    \"4-0\": \"description\",\n    \"4-1\": \"*String* \",\n    \"5-0\": \"title\",\n    \"5-1\": \"*String* \",\n    \"6-0\": \"timezone\",\n    \"6-1\": \"*String* \",\n    \"7-0\": \"calendarId\",\n    \"7-1\": \"*String* \",\n    \"8-0\": \"calendarName\",\n    \"8-1\": \"*String* \",\n    \"9-0\": \"guestsCanModify\",\n    \"9-1\": \"*Boolean* \",\n    \"10-0\": \"timeslots\",\n    \"0-2\": \"Unique ID\",\n    \"h-2\": \"Description\",\n    \"1-2\": \"Unix timestamp of when it was created\",\n    \"2-2\": \"Your user id\",\n    \"3-2\": \"Location field when it was created\",\n    \"4-2\": \"Description field when it was created\",\n    \"5-2\": \"Title field when it was created\",\n    \"6-2\": \"The timezone selected\",\n    \"7-2\": \"Google calendar ID\",\n    \"8-2\": \"Google calendar name\",\n    \"9-2\": \"Value of the \\\"Guests can Modify\\\" checkbox when it was created\",\n    \"10-1\": \"*Array* \",\n    \"10-2\": \"Array of proposed timeslots. Details below\",\n    \"14-0\": \"allowDoubleBookings\",\n    \"14-1\": \"*Boolean* \",\n    \"14-2\": \"Value of the \\\"Allow Double Bookings\\\" checkbox when it was created\",\n    \"15-0\": \"additionalGuests\",\n    \"15-1\": \"*Array* \",\n    \"15-2\": \"Array of addition guests that were added when it was created\",\n    \"11-0\": \"timeslots.start\",\n    \"11-1\": \"*Date*\",\n    \"12-0\": \"timeslots.end\",\n    \"12-1\": \"*Date*\",\n    \"13-0\": \"timeslots.events\",\n    \"11-2\": \"Start time of timeslot\",\n    \"12-2\": \"End time of timeslot\",\n    \"13-1\": \"*Array*\",\n    \"13-2\": \"Array of events that represent users accepting the availability invite.\"\n  },\n  \"cols\": 3,\n  \"rows\": 16\n}\n[/block]","excerpt":"Returns a list of \"Share Availability\" enhancements that you have sent out","slug":"availability","type":"get","title":"/availability"}

get/availability

Returns a list of "Share Availability" enhancements that you have sent out

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

This API returns a list of objects created each time you've proposed your availability using Mixmax. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "0-0": "_id", "0-1": "*String* ", "1-0": "creationDate", "1-1": "*Timestamp* ", "2-0": "userId", "2-1": "*String* ", "3-0": "location", "3-1": "*String* ", "4-0": "description", "4-1": "*String* ", "5-0": "title", "5-1": "*String* ", "6-0": "timezone", "6-1": "*String* ", "7-0": "calendarId", "7-1": "*String* ", "8-0": "calendarName", "8-1": "*String* ", "9-0": "guestsCanModify", "9-1": "*Boolean* ", "10-0": "timeslots", "0-2": "Unique ID", "h-2": "Description", "1-2": "Unix timestamp of when it was created", "2-2": "Your user id", "3-2": "Location field when it was created", "4-2": "Description field when it was created", "5-2": "Title field when it was created", "6-2": "The timezone selected", "7-2": "Google calendar ID", "8-2": "Google calendar name", "9-2": "Value of the \"Guests can Modify\" checkbox when it was created", "10-1": "*Array* ", "10-2": "Array of proposed timeslots. Details below", "14-0": "allowDoubleBookings", "14-1": "*Boolean* ", "14-2": "Value of the \"Allow Double Bookings\" checkbox when it was created", "15-0": "additionalGuests", "15-1": "*Array* ", "15-2": "Array of addition guests that were added when it was created", "11-0": "timeslots.start", "11-1": "*Date*", "12-0": "timeslots.end", "12-1": "*Date*", "13-0": "timeslots.events", "11-2": "Start time of timeslot", "12-2": "End time of timeslot", "13-1": "*Array*", "13-2": "Array of events that represent users accepting the availability invite." }, "cols": 3, "rows": 16 } [/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 }}