Oncehub API

oncehub.json

{"openapi":"3.1.0","info":{"title":"oncehub","version":"2.0.0"},"servers":[{"url":"https://api.oncehub.com/v2"}],"components":{"securitySchemes":{"sec0":{"type":"apiKey","in":"header","name":"API-Key"}}},"security":[{"sec0":[]}],"paths":{"/test":{"get":{"summary":"Validate API key","description":"Enter your API key in the headers section below and click on \"Try it\" to test it.","operationId":"validate-api-key","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"message\": \"The API key is valid for account: [email protected]\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The API key is valid for account: [email protected]"}}}}}},"401":{"description":"401","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"authentication_error\",\n  \"message\": \"Invalid API key.\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"authentication_error"},"message":{"type":"string","example":"Invalid API key."}}}}}},"403":{"description":"403","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"authentication_error\",\n  \"message\": \"Your account plan does not support API access. To use the ScheduleOnce API, you must upgrade to the Enterprise plan.\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"authentication_error"},"message":{"type":"string","example":"Your account plan does not support API access. To use the ScheduleOnce API, you must upgrade to the Enterprise plan."}}}}}}},"deprecated":false}},"/bookings":{"get":{"summary":"List all bookings","description":"Returns a list all bookings in the account","operationId":"list-all-bookings","parameters":[{"name":"status","in":"query","description":"Only return bookings that have the given status.","schema":{"type":"string"}},{"name":"owner","in":"query","description":"Only return booking owned by a user with a specific user ID.","schema":{"type":"string"}},{"name":"contact","in":"query","description":"Only return bookings that were scheduled with the contact with the provided ID.","schema":{"type":"string"}},{"name":"booking_page","in":"query","description":"Only return bookings that were created from the booking page with the provided ID.","schema":{"type":"string"}},{"name":"master_page","in":"query","description":"Only return bookings that were created from the master page with the provided ID.","schema":{"type":"string"}},{"name":"event_type","in":"query","description":"Only return bookings that were created using the event type with the provided ID.","schema":{"type":"string"}},{"name":"creation_time.gt","in":"query","description":"Return bookings with creation time greater than the given date.","schema":{"type":"string","format":"date"}},{"name":"creation_time.lt","in":"query","description":"Return bookings with creation time less than the given date.","schema":{"type":"string","format":"date"}},{"name":"starting_time.gt","in":"query","description":"Return bookings with starting time greater than the given date.","schema":{"type":"string","format":"date"}},{"name":"starting_time.lt","in":"query","description":"Return bookings with starting time less than the given date.","schema":{"type":"string","format":"date"}},{"name":"last_updated_time.gt","in":"query","description":"Return bookings with last updated time greater than the given date.","schema":{"type":"string","format":"date"}},{"name":"last_updated_time.lt","in":"query","description":"Return bookings with last updated time less than the given date.","schema":{"type":"string","format":"date"}},{"name":"expand","in":"query","description":"A comma separated list of fields that you want to [expand](https://developers.oncehub.com/v2.0.0/reference#expanding-responses). Possible values are `booking_page`, `master_page`, `event_type`, `owner`.","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}},{"name":"booking_calendar","in":"query","required":false,"description":"Only return bookings that were created from the booking calendar with the provided ID.","schema":{"type":"string","default":""}},{"name":"host","in":"query","required":false,"description":"Only return bookings hosted or co-hosted by a user with a specific user ID.","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"object\": \"booking\",\n      \"id\": \"BKNG-J4FR05BKEWEX\",\n      \"tracking_id\": \"D36E0002\",\n      \"subject\": \"Live demo\",\n      \"status\": \"scheduled\",\n      \"creation_time\": \"2020-03-22T09:48:48Z\",\n      \"starting_time\": \"2020-03-22T04:30:00Z\",\n      \"customer_timezone\": \"America/New_York\",\n      \"last_updated_time\": \"2020-03-22T09:48:48Z\",\n      \"owner\": \"USR-FSD423423\",\n      \"duration_minutes\": 60,\n      \"virtual_conferencing\": {\n        \"join_url\": \"https://meet.google.com/izv-daci-fyi\"\n      },\n      \"location_description\": \"123 Office Street\",\n      \"rescheduled_booking_id\": \"BKNG-J4FR05BKEWEX\",\n      \"cancel_reschedule_information\": {\n        \"reason\": \"Change in schedule\",\n        \"actioned_by\": \"user\",\n        \"user_id\": \"USR-FSD423423\"\n      },\n      \"attendees\": [\"[email protected]\", \"[email protected]\"],\n      \"form_submission\": {\n        \"name\": \"Carrie Customer\",\n        \"email\": \"[email protected]\",\n        \"phone\": null,\n        \"mobile_phone\": \"1-2025550195\",\n        \"note\": \"I want to discuss whether your product can work for our office.\",\n        \"company\": null,\n        \"guests\": [],\n        \"custom_fields\": [\n          { \"name\": \"Title\", \"value\": \"Executive Assistant\" },\n          { \"name\": \"Office size\", \"value\": \"30-50 people\" },\n          { \"name\": \"Industry\", \"value\": \"Lawnscaping services\" }\n        ]\n      },\n      \"booking_page\": \"BP-X0LCRU5LES\",\n      \"master_page\": \"MP-ZID28U5946\",\n      \"event_type\": \"ET-7NC41GHIDZ\",\n      \"external_calendar\": {\n        \"type\": \"google\",\n        \"name\": \"[email protected]\",\n        \"id\": \"[email protected]\",\n        \"event_id\": \"8kvu74dda8kcv0gmmlm3folrhc\"\n      },\n      \"utm_params\": {\n        \"source\": \"facebook\",\n        \"medium\": \"social\",\n        \"campaign\": null,\n        \"term\": null,\n        \"content\": null\n      },\n      \"contact\": \"CTC-262WER5NR9CG38\",\n      \"booking_calendar\": \"BKC-03WJV0R52Z\",\n      \"cancel_url\": \"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel\",\n      \"reschedule_url\": \"https://oncehub.com/m/BKNG-3KM0HY2BF9SL\",\n\t\t\t\"custom_fields\": [\n        {\n          \"name\": \"discussion_points\",\n          \"value\": \"Need support on new product\"\n        },\n        {\n          \"name\": \"meeting_reason\",\n          \"value\": \"Product demo\"\n        }\n      ]\n    },\n    {...},\n    {...}\n  ]\n}\n"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"last_updated_time.gt cannot be later than last_updated_time.lt\",\n  \"param\": \"last_updated_time.gt\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"creation_time.gt cannot be later than creation_time.lt"},"param":{"type":"string","example":"creation_time.gt"}}}}}}},"deprecated":false}},"/bookings/{id}":{"get":{"summary":"Get a single booking","description":"Returns a single booking by ID","operationId":"get-a-single-booking","parameters":[{"name":"id","in":"path","description":"ID of the booking","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"object":"booking","id":"BKNG-J4FR05BKEWEX","tracking_id":"D36E0002","subject":"Live demo","status":"scheduled","creation_time":"2020-03-22T09:48:48Z","starting_time":"2020-03-22T04:30:00Z","customer_timezone":"America/New_York","last_updated_time":"2020-03-22T09:48:48Z","owner":"USR-FSD423423","duration_minutes":60,"virtual_conferencing":{"join_url":"https://meet.google.com/izv-daci-fyi"},"location_description":"123 Office Street","rescheduled_booking_id":"BKNG-J4FR05BKEWEX","cancel_reschedule_information":{"reason":"Change in schedule","actioned_by":"user","user_id":"USR-FSD423423"},"attendees":["[email protected]","[email protected]"],"form_submission":{"name":"Carrie Customer","email":"[email protected]","phone":null,"mobile_phone":"1-2025550195","note":"I want to discuss whether your product can work for our office.","company":null,"guests":[],"custom_fields":[{"name":"Title","value":"Executive Assistant"},{"name":"Office size","value":"30-50 people"},{"name":"Industry","value":"Lawnscaping services"}]},"booking_page":"BP-X0LCRU5LES","master_page":"MP-ZID28U5946","event_type":"ET-7NC41GHIDZ","external_calendar":{"type":"google","name":"[email protected]","id":"[email protected]","event_id":"8kvu74dda8kcv0gmmlm3folrhc"},"utm_params":{"source":"facebook","medium":"social","campaign":null,"term":null,"content":null},"contact":"CTC-262WER5NR9CG38","booking_calendar":"BKC-03WJV0R52Z","cancel_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel","reschedule_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL","custom_fields":[{"name":"discussion_points","value":"Need support on new product"},{"name":"meeting_reason","value":"Product demo"}]}}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"booking"},"id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"tracking_id":{"type":"string","example":"D36E0002"},"subject":{"type":"string","example":"Live demo"},"status":{"type":"string","example":"scheduled"},"creation_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"starting_time":{"type":"string","example":"2020-03-22T04:30:00Z"},"customer_timezone":{"type":"string","example":"America/New_York"},"last_updated_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"owner":{"type":"string","example":"USR-FSD423423"},"duration_minutes":{"type":"integer","example":60,"default":0},"virtual_conferencing":{"type":"object","properties":{"join_url":{"type":"string","example":"https://meet.google.com/izv-daci-fyi"}}},"location_description":{"type":"string","example":"123 Office Street"},"rescheduled_booking_id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"cancel_reschedule_information":{"type":"object","properties":{"reason":{"type":"string","example":"Change in schedule"},"actioned_by":{"type":"string","example":"user"},"user_id":{"type":"string","example":"USR-FSD423423"}}},"attendees":{"type":"array","items":{"type":"string","example":"[email protected]"}},"form_submission":{"type":"object","properties":{"name":{"type":"string","example":"Carrie Customer"},"email":{"type":"string","example":"[email protected]"},"phone":{},"mobile_phone":{"type":"string","example":"1-2025550195"},"note":{"type":"string","example":"I want to discuss whether your product can work for our office."},"company":{},"guests":{"type":"array"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"value":{"type":"string","example":"Executive Assistant"}}}}}},"booking_page":{"type":"string","example":"BP-X0LCRU5LES"},"master_page":{"type":"string","example":"MP-ZID28U5946"},"event_type":{"type":"string","example":"ET-7NC41GHIDZ"},"external_calendar":{"type":"object","properties":{"type":{"type":"string","example":"google"},"name":{"type":"string","example":"[email protected]"},"id":{"type":"string","example":"[email protected]"},"event_id":{"type":"string","example":"8kvu74dda8kcv0gmmlm3folrhc"}}},"utm_params":{"type":"object","properties":{"source":{"type":"string","example":"facebook"},"medium":{"type":"string","example":"social"},"campaign":{},"term":{},"content":{}}},"contact":{"type":"string","example":"CTC-262WER5NR9CG38"},"booking_calendar":{"type":"string","example":"BKC-03WJV0R52Z"},"cancel_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel"},"reschedule_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/bookings/{id}/cancel":{"post":{"summary":"Cancel a booking","description":"Cancel a booking by ID","operationId":"cancel-booking","parameters":[{"name":"id","in":"path","description":"ID of the booking","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cancellation_reason":{"type":"string","description":"Reason for cancelling the meeting (optional)"},"send_cancellation_email":{"type":"boolean","description":"Whether a cancellation email should be sent","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"object":"booking","id":"BKNG-J4FR05BKEWEX","tracking_id":"D36E0002","subject":"Live demo","status":"canceled","creation_time":"2020-03-22T09:48:48Z","starting_time":"2020-03-22T04:30:00Z","customer_timezone":"America/New_York","last_updated_time":"2020-03-22T09:48:48Z","owner":"USR-FSD423423","duration_minutes":60,"virtual_conferencing":{"join_url":"https://meet.google.com/izv-daci-fyi"},"location_description":"123 Office Street","rescheduled_booking_id":"BKNG-J4FR05BKEWEX","cancel_reschedule_information":{"reason":"Change in schedule","actioned_by":"user","user_id":"USR-FSD423423"},"attendees":["[email protected]","[email protected]"],"form_submission":{"name":"Carrie Customer","email":"[email protected]","phone":null,"mobile_phone":"1-2025550195","note":"I want to discuss whether your product can work for our office.","company":null,"guests":[],"custom_fields":[{"name":"Title","value":"Executive Assistant"},{"name":"Office size","value":"30-50 people"},{"name":"Industry","value":"Lawnscaping services"}]},"booking_page":"BP-X0LCRU5LES","master_page":"MP-ZID28U5946","event_type":"ET-7NC41GHIDZ","external_calendar":{"type":"google","name":"[email protected]","id":"[email protected]","event_id":"8kvu74dda8kcv0gmmlm3folrhc"},"utm_params":{"source":"facebook","medium":"social","campaign":null,"term":null,"content":null},"contact":"CTC-262WER5NR9CG38","booking_calendar":"BKC-03WJV0R52Z","cancel_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel","reschedule_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL","custom_fields":[{"name":"discussion_points","value":"Need support on new product"},{"name":"meeting_reason","value":"Product demo"}]}}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"booking"},"id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"tracking_id":{"type":"string","example":"D36E0002"},"subject":{"type":"string","example":"Live demo"},"status":{"type":"string","example":"canceled"},"creation_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"starting_time":{"type":"string","example":"2020-03-22T04:30:00Z"},"customer_timezone":{"type":"string","example":"America/New_York"},"last_updated_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"owner":{"type":"string","example":"USR-FSD423423"},"duration_minutes":{"type":"integer","example":60,"default":0},"virtual_conferencing":{"type":"object","properties":{"join_url":{"type":"string","example":"https://meet.google.com/izv-daci-fyi"}}},"location_description":{"type":"string","example":"123 Office Street"},"rescheduled_booking_id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"cancel_reschedule_information":{"type":"object","properties":{"reason":{"type":"string","example":"Change in schedule"},"actioned_by":{"type":"string","example":"user"},"user_id":{"type":"string","example":"USR-FSD423423"}}},"attendees":{"type":"array","items":{"type":"string","example":"[email protected]"}},"form_submission":{"type":"object","properties":{"name":{"type":"string","example":"Carrie Customer"},"email":{"type":"string","example":"[email protected]"},"phone":{},"mobile_phone":{"type":"string","example":"1-2025550195"},"note":{"type":"string","example":"I want to discuss whether your product can work for our office."},"company":{},"guests":{"type":"array"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"value":{"type":"string","example":"Executive Assistant"}}}}}},"booking_page":{"type":"string","example":"BP-X0LCRU5LES"},"master_page":{"type":"string","example":"MP-ZID28U5946"},"event_type":{"type":"string","example":"ET-7NC41GHIDZ"},"external_calendar":{"type":"object","properties":{"type":{"type":"string","example":"google"},"name":{"type":"string","example":"[email protected]"},"id":{"type":"string","example":"[email protected]"},"event_id":{"type":"string","example":"8kvu74dda8kcv0gmmlm3folrhc"}}},"utm_params":{"type":"object","properties":{"source":{"type":"string","example":"facebook"},"medium":{"type":"string","example":"social"},"campaign":{},"term":{},"content":{}}},"contact":{"type":"string","example":"CTC-262WER5NR9CG38"},"booking_calendar":{"type":"string","example":"BKC-03WJV0R52Z"},"cancel_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel"},"reschedule_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking: '123'"},"param":{"type":"string","example":"id"}}}}}},"409":{"description":"409","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Booking cannot be cancelled: '123'\",\n  \"params\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Booking cannot be cancelled: '123'"},"params":{"type":"string","example":"id"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Paid bookings cannot be canceled through this endpoint. Please login to OnceHub and use the Activity Stream to cancel paid bookings.\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Paid bookings cannot be canceled through this endpoint. Please login to OnceHub and use the Activity Stream to cancel paid bookings."}}}}}}},"deprecated":false}},"/bookings/{id}/request-reschedule":{"post":{"summary":"Request a reschedule","description":"Request to reschedule a booking by ID","operationId":"request-reschedule","parameters":[{"name":"id","in":"path","description":"ID of the booking","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reschedule_reason":{"type":"string","description":"Reason for requesting the customer to reschedule the meeting (optional)"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"object":"booking","id":"BKNG-J4FR05BKEWEX","tracking_id":"D36E0002","subject":"Live demo","status":"canceled","creation_time":"2020-03-22T09:48:48Z","starting_time":"2020-03-22T04:30:00Z","customer_timezone":"America/New_York","last_updated_time":"2020-03-22T09:48:48Z","owner":"USR-FSD423423","duration_minutes":60,"virtual_conferencing":{"join_url":"https://meet.google.com/izv-daci-fyi"},"location_description":"123 Office Street","rescheduled_booking_id":"BKNG-J4FR05BKEWEX","cancel_reschedule_information":{"reason":"Change in schedule","actioned_by":"user","user_id":"USR-FSD423423"},"attendees":["[email protected]","[email protected]"],"form_submission":{"name":"Carrie Customer","email":"[email protected]","phone":null,"mobile_phone":"1-2025550195","note":"I want to discuss whether your product can work for our office.","company":null,"guests":[],"custom_fields":[{"name":"Title","value":"Executive Assistant"},{"name":"Office size","value":"30-50 people"},{"name":"Industry","value":"Lawnscaping services"}]},"booking_page":"BP-X0LCRU5LES","master_page":"MP-ZID28U5946","event_type":"ET-7NC41GHIDZ","external_calendar":{"type":"google","name":"[email protected]","id":"[email protected]","event_id":"8kvu74dda8kcv0gmmlm3folrhc"},"utm_params":{"source":"facebook","medium":"social","campaign":null,"term":null,"content":null},"contact":"CTC-262WER5NR9CG38","booking_calendar":"BKC-03WJV0R52Z","cancel_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel","reschedule_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL","custom_fields":[{"name":"discussion_points","value":"Need support on new product"},{"name":"meeting_reason","value":"Product demo"}]}}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"booking"},"id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"tracking_id":{"type":"string","example":"D36E0002"},"subject":{"type":"string","example":"Live demo"},"status":{"type":"string","example":"canceled"},"creation_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"starting_time":{"type":"string","example":"2020-03-22T04:30:00Z"},"customer_timezone":{"type":"string","example":"America/New_York"},"last_updated_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"owner":{"type":"string","example":"USR-FSD423423"},"duration_minutes":{"type":"integer","example":60,"default":0},"virtual_conferencing":{"type":"object","properties":{"join_url":{"type":"string","example":"https://meet.google.com/izv-daci-fyi"}}},"location_description":{"type":"string","example":"123 Office Street"},"rescheduled_booking_id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"cancel_reschedule_information":{"type":"object","properties":{"reason":{"type":"string","example":"Change in schedule"},"actioned_by":{"type":"string","example":"user"},"user_id":{"type":"string","example":"USR-FSD423423"}}},"attendees":{"type":"array","items":{"type":"string","example":"[email protected]"}},"form_submission":{"type":"object","properties":{"name":{"type":"string","example":"Carrie Customer"},"email":{"type":"string","example":"[email protected]"},"phone":{},"mobile_phone":{"type":"string","example":"1-2025550195"},"note":{"type":"string","example":"I want to discuss whether your product can work for our office."},"company":{},"guests":{"type":"array"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"value":{"type":"string","example":"Executive Assistant"}}}}}},"booking_page":{"type":"string","example":"BP-X0LCRU5LES"},"master_page":{"type":"string","example":"MP-ZID28U5946"},"event_type":{"type":"string","example":"ET-7NC41GHIDZ"},"external_calendar":{"type":"object","properties":{"type":{"type":"string","example":"google"},"name":{"type":"string","example":"[email protected]"},"id":{"type":"string","example":"[email protected]"},"event_id":{"type":"string","example":"8kvu74dda8kcv0gmmlm3folrhc"}}},"utm_params":{"type":"object","properties":{"source":{"type":"string","example":"facebook"},"medium":{"type":"string","example":"social"},"campaign":{},"term":{},"content":{}}},"contact":{"type":"string","example":"CTC-262WER5NR9CG38"},"booking_calendar":{"type":"string","example":"BKC-03WJV0R52Z"},"cancel_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel"},"reschedule_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking: '123'"},"param":{"type":"string","example":"id"}}}}}},"409":{"description":"409","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Booking cannot be cancelled: '123'\",\n  \"params\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Booking cannot be cancelled: '123'"},"params":{"type":"string","example":"id"}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Paid bookings can only be requested for reschedule in your OnceHub account. Log in and use the activity stream to submit a reschedule request for this booking.\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Paid bookings can only be requested for reschedule in your OnceHub account. Log in and use the activity stream to submit a reschedule request for this booking."}}}}}}},"deprecated":false}},"/bookings/{id}/no-show":{"post":{"summary":"Set a booking as no-show","description":"Update the booking status to no-show by ID","operationId":"no-show","parameters":[{"name":"id","in":"path","description":"ID of the booking","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"object":"booking","id":"BKNG-J4FR05BKEWEX","tracking_id":"D36E0002","subject":"Live demo","status":"no_show","creation_time":"2020-03-22T09:48:48Z","starting_time":"2020-03-22T04:30:00Z","customer_timezone":"America/New_York","last_updated_time":"2020-03-22T09:48:48Z","owner":"USR-FSD423423","duration_minutes":60,"virtual_conferencing":{"join_url":"https://meet.google.com/izv-daci-fyi"},"location_description":"123 Office Street","rescheduled_booking_id":"BKNG-J4FR05BKEWEX","cancel_reschedule_information":{"reason":"Change in schedule","actioned_by":"user","user_id":"USR-FSD423423"},"attendees":["[email protected]","[email protected]"],"form_submission":{"name":"Carrie Customer","email":"[email protected]","phone":null,"mobile_phone":"1-2025550195","note":"I want to discuss whether your product can work for our office.","company":null,"guests":[],"custom_fields":[{"name":"Title","value":"Executive Assistant"},{"name":"Office size","value":"30-50 people"},{"name":"Industry","value":"Lawnscaping services"}]},"booking_page":"BP-X0LCRU5LES","master_page":"MP-ZID28U5946","event_type":"ET-7NC41GHIDZ","external_calendar":{"type":"google","name":"[email protected]","id":"[email protected]","event_id":"8kvu74dda8kcv0gmmlm3folrhc"},"utm_params":{"source":"facebook","medium":"social","campaign":null,"term":null,"content":null},"contact":"CTC-262WER5NR9CG38","booking_calendar":"BKC-03WJV0R52Z","cancel_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel","reschedule_url":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL","custom_fields":[{"name":"discussion_points","value":"Need support on new product"},{"name":"meeting_reason","value":"Product demo"}]}}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"booking"},"id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"tracking_id":{"type":"string","example":"D36E0002"},"subject":{"type":"string","example":"Live demo"},"status":{"type":"string","example":"no_show"},"creation_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"starting_time":{"type":"string","example":"2020-03-22T04:30:00Z"},"customer_timezone":{"type":"string","example":"America/New_York"},"last_updated_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"owner":{"type":"string","example":"USR-FSD423423"},"duration_minutes":{"type":"integer","example":60,"default":0},"virtual_conferencing":{"type":"object","properties":{"join_url":{"type":"string","example":"https://meet.google.com/izv-daci-fyi"}}},"location_description":{"type":"string","example":"123 Office Street"},"rescheduled_booking_id":{"type":"string","example":"BKNG-J4FR05BKEWEX"},"cancel_reschedule_information":{"type":"object","properties":{"reason":{"type":"string","example":"Change in schedule"},"actioned_by":{"type":"string","example":"user"},"user_id":{"type":"string","example":"USR-FSD423423"}}},"attendees":{"type":"array","items":{"type":"string","example":"[email protected]"}},"form_submission":{"type":"object","properties":{"name":{"type":"string","example":"Carrie Customer"},"email":{"type":"string","example":"[email protected]"},"phone":{},"mobile_phone":{"type":"string","example":"1-2025550195"},"note":{"type":"string","example":"I want to discuss whether your product can work for our office."},"company":{},"guests":{"type":"array"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Title"},"value":{"type":"string","example":"Executive Assistant"}}}}}},"booking_page":{"type":"string","example":"BP-X0LCRU5LES"},"master_page":{"type":"string","example":"MP-ZID28U5946"},"event_type":{"type":"string","example":"ET-7NC41GHIDZ"},"external_calendar":{"type":"object","properties":{"type":{"type":"string","example":"google"},"name":{"type":"string","example":"[email protected]"},"id":{"type":"string","example":"[email protected]"},"event_id":{"type":"string","example":"8kvu74dda8kcv0gmmlm3folrhc"}}},"utm_params":{"type":"object","properties":{"source":{"type":"string","example":"facebook"},"medium":{"type":"string","example":"social"},"campaign":{},"term":{},"content":{}}},"contact":{"type":"string","example":"CTC-262WER5NR9CG38"},"booking_calendar":{"type":"string","example":"BKC-03WJV0R52Z"},"cancel_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL/cancel"},"reschedule_url":{"type":"string","example":"https://oncehub.com/m/BKNG-3KM0HY2BF9SL"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking: '123'"},"param":{"type":"string","example":"id"}}}}}},"409":{"description":"409","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Cannot update booking status to no_show: '123'\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Cannot update booking status to no_show: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/booking-calendars":{"get":{"summary":"List all booking calendars","description":"Returns a list of all booking calendars in your account","operationId":"list-all-booking-calendars","parameters":[{"name":"host","in":"query","description":"Filter booking calendars hosted by this user ID or team ID","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"object\": \"booking_calendar\",\n      \"id\": \"BKC-LDJ878496X\",\n      \"subject\": \"Meeting with Gilad Goraly\",\n      \"host\": \"USR-HYPGJXN3A8\",\n      \"url\": \"https://oncehub.com/gilad15\",\n      \"name\": \"Gilad Goraly booking calendar\",\n      \"published\": true,\n      \"duration_minutes\": 30\n    }\n    {...},\n    {...}\n  ]\n}"}}}}}},"deprecated":false}},"/booking-calendars/{id}":{"get":{"summary":"Get a single booking calendar","description":"Returns a single booking calendar by ID","operationId":"get-a-single-booking-calendar","parameters":[{"name":"id","in":"path","description":"ID of the booking calendar","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"booking_calendar\",\n  \"id\": \"BKC-LDJ878496X\",\n  \"subject\": \"Meeting with Gilad Goraly\",\n  \"host\": \"USR-HYPGJXN3A8\",\n  \"url\": \"https://oncehub.com/gilad15\",\n  \"name\": \"Gilad Goraly booking calendar\",\n  \"published\": true,\n  \"duration_minutes\": 30\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"booking_calendar"},"id":{"type":"string","example":"BKC-LDJ878496X"},"subject":{"type":"string","example":"Meeting with Gilad Goraly"},"host":{"type":"string","example":"USR-HYPGJXN3A8"},"url":{"type":"string","example":"https://oncehub.com/gilad15"},"name":{"type":"string","example":"Gilad Goraly booking calendar"},"published":{"type":"boolean","example":true,"default":true},"duration_minutes":{"type":"integer","example":30,"default":0}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking page: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking page: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/booking-calendars/{id}/time-slots":{"get":{"summary":"Get available time slots for a booking calendar","description":"Returns a list of available time slots for a booking calendar","operationId":"get-available-time-slots-for-booking-calendar","parameters":[{"name":"start_time","in":"query","required":false,"description":"The date and time from which to begin checking for available slots. If not provided, the system defaults to current time.","schema":{"type":"string","format":"date-time","default":""}},{"name":"end_time","in":"query","required":false,"description":"The date and time up to which to check for available slots. If not provided, the system defaults to one week from `start_time`.","schema":{"type":"string","format":"date-time","default":""}},{"name":"id","in":"path","description":"ID of the booking calendar","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n  {\n    \"start_time\": \"2024-12-02T06:30:00.000Z\",\n    \"locations\": [\n      {\n        \"type\": \"virtual\",\n        \"value\": \"google_meet\",\n        \"id\": null\n      },\n      {\n        \"type\": \"guest_phone\",\n        \"value\": \"+12025550195\",\n        \"id\": null\n      }\n    ]\n  },\n  {\n    \"start_time\": \"2024-12-05T14:30:00.000Z\",\n    \"locations\": [\n      {\n        \"type\": \"physical\",\n        \"value\": null,\n        \"id\": \"ADD-17SE9FWWOC\"\n      }\n    ]\n  },\n  // ...\n]\n"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"End time must be after the start time.\",\n  \"param\": \"end_time\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Start time cannot be in the past."},"param":{"type":"string","example":"start_time"}}}}}},"402":{"description":"402","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Time slots cannot be retrieved when the host doesn't have a seat assigned.\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Time slots cannot be retrieved when the host doesn't have a seat assigned."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Time slots cannot be retrieved from an unpublished booking calendar.\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Time slots cannot be retrieved from an unpublished booking calendar."},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/booking-calendars/{id}/schedule":{"post":{"summary":"Book a time slot","description":"Book a time from the available time slots","operationId":"book-a-time-slot-for-a-booking-calendar","parameters":[{"name":"id","in":"path","description":"ID of the booking calendar","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":"The date and time of the time slot","x-readme-id":"0.0"},"guest_time_zone":{"type":"string","description":"The guest's timezone in [IANA timezone format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)","x-readme-id":"0.1"},"booking_form":{"type":"object","description":"An object containing information about the guest","properties":{"name":{"type":"string","description":"Name of the guest","x-readme-id":"1.0"},"email":{"type":"string","description":"Email of the guest","x-readme-id":"1.1"}},"required":["name","email"],"x-readme-id":"0.2"},"location":{"properties":{"type":{"type":"string","description":"Use `physical` for in-person meetings, `virtual` for online meetings, or `guest_phone` for phone calls.","x-readme-id":"1.0"},"value":{"type":"string","description":"For virtual meetings, specify one of the following: `google_meet`, `microsoft_teams`, `gotomeeting`, `webex`, or `zoom`. For phone calls, use the guest's phone number in E164 format. For in-person meetings, use the location's address ID (e.g., `ADD-1234`).","x-readme-id":"1.1"}},"required":[],"type":"object","description":"The meeting location object. This field is optional; if omitted, a virtual location will be selected.","x-readme-id":"0.3"}},"required":["start_time","guest_time_zone","booking_form"]}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"BKNG-J4FR05BKEWEX\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"BKNG-J4FR05BKEWEX"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Required fields are missing.\",\n  \"param\": \"booking_form\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"The selected start time is not available."},"param":{"type":"string","example":"start_time"}}}}}},"402":{"description":"402","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Meeting cannot be scheduled when the host doesn't have a seat assigned.\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Meeting cannot be scheduled when the host doesn't have a seat assigned."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"Meeting cannot be scheduled on an unpublished booking calendar.\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"Meeting cannot be scheduled on an unpublished booking calendar."},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/booking-calendars/{id}/one-time-links":{"post":{"summary":"Create a one-time link","description":"Creates a one time link for a booking calendar","operationId":"booking-calendars-create-a-one-time-link","parameters":[{"name":"id","in":"path","description":"ID of the booking calendar","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"QUHVEKLPD93M\",\n  \"url\": \"https://oncehub.com/.QUHVEKLPD93M\",\n  \"creation_time\": \"2024-06-18T14:28:19Z\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"QUHVEKLPD93M"},"url":{"type":"string","example":"https://oncehub.com/.QUHVEKLPD93M"},"creation_time":{"type":"string","example":"2024-06-18T14:28:19Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"Bad Request\",\n  \"message\": \"This booking calendar does not allow creation of one time links: 'BKC-1234'\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"This booking calendar does not allow creation of one time links: 'BKC-1234'"},"param":{"type":"string","example":"id"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking calendar: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking calendar: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/booking-pages":{"get":{"summary":"List all booking pages","description":"Returns a list of all booking pages in your account","operationId":"list-all-booking-pages","parameters":[{"name":"master_page","in":"query","description":"Filter booking pages that are associated with this master page ID","schema":{"type":"string"}},{"name":"event_type","in":"query","description":"Filter booking pages that are associated with this event type ID","schema":{"type":"string"}},{"name":"user","in":"query","description":"Filter booking pages owned by this user ID","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"id\": \"BP-3F7JAWT4UA\",\n      \"object\": \"booking_page\",\n      \"name\": \"Andrea Hartie\",\n      \"label\": \"AndreaHartie\",\n      \"url\": \"https://go.oncehub.com/andreahartie\",\n      \"active\": true,\n      \"timezone\": \"America/Chicago\"\n\t\t},\n    {...},\n    {...}\n  ]\n}"}}}}}},"deprecated":false}},"/booking-pages/{id}":{"get":{"summary":"Get a single booking page","description":"Returns a single booking page by ID","operationId":"get-a-single-booking-page","parameters":[{"name":"id","in":"path","description":"ID of the booking page","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"BP-3F7JAWT4UA\",\n  \"object\": \"booking_page\",\n  \"name\": \"Andrea Hartie\",\n  \"label\": \"AndreaHartie\",\n  \"url\": \"https://go.oncehub.com/andreahartie\",\n  \"active\": true,\n  \"timezone\": \"America/Chicago\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"BP-3F7JAWT4UA"},"object":{"type":"string","example":"booking_page"},"name":{"type":"string","example":"Andrea Hartie"},"label":{"type":"string","example":"AndreaHartie"},"url":{"type":"string","example":"https://go.oncehub.com/andreahartie"},"active":{"type":"boolean","example":true,"default":true},"timezone":{"type":"string","example":"America/Chicago"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such booking page: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such booking page: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/event-types":{"get":{"summary":"List all event types","description":"Returns a list of all event types in your account","operationId":"list-all-event-types","parameters":[{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"id\": \"ET-7I7PKDTFJS\",\n      \"object\": \"event_type\",\n      \"name\": \"Live demo\",\n      \"description\": \"Schedule a live demo with us for an in-depth look at our enterprise solutions.\"\n    },\n    {...},\n    {...}\n  ]\n}"}}}}}},"deprecated":false}},"/event-types/{id}":{"get":{"summary":"Get a single event type","description":"Returns a single event type by ID","operationId":"get-a-single-event-type","parameters":[{"name":"id","in":"path","description":"ID of the event type","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"ET-7I7PKDTFJS\",\n  \"object\": \"event_type\",\n  \"name\": \"Live demo\",\n  \"description\": \"Schedule a live demo with us for an in-depth look at our enterprise solutions.\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ET-7I7PKDTFJS"},"object":{"type":"string","example":"event_type"},"name":{"type":"string","example":"Live demo"},"description":{"type":"string","example":"Schedule a live demo with us for an in-depth look at our enterprise solutions."}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such event type: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such event type: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/master-pages":{"get":{"summary":"List all master pages","description":"Returns a list of all master pages in your account","operationId":"list-all-master-pages","parameters":[{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n{\n  \"id\": \"MP-73E6RHFU77\",\n  \"object\": \"master_page\",\n  \"name\": \"Star Software LLC\",\n  \"label\": \"Dana\",\n  \"url\": \"https://go.oncehub.com/dana\",\n  \"active\": true\n},\n    {...},\n    {...}\n  ]\n}"}}}}}},"deprecated":false}},"/master-pages/{id}":{"get":{"summary":"Get a single master page","description":"Returns a single master page by ID","operationId":"get-a-single-master-page","parameters":[{"name":"id","in":"path","description":"ID of the master page","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"MP-73E6RHFU77\",\n  \"object\": \"master_page\",\n  \"name\": \"Star Software LLC\",\n  \"label\": \"Dana\",\n  \"url\": \"https://go.oncehub.com/dana\",\n  \"active\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"MP-73E6RHFU77"},"object":{"type":"string","example":"master_page"},"name":{"type":"string","example":"Star Software LLC"},"label":{"type":"string","example":"Dana"},"url":{"type":"string","example":"https://go.oncehub.com/dana"},"active":{"type":"boolean","example":true,"default":true}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such master page: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such master page: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/master-pages/{id}/one-time-links":{"post":{"summary":"Create a one-time link","description":"Creates a one time link for a master page","operationId":"create-one-time-link","parameters":[{"name":"id","in":"path","description":"ID of the master page","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"S617NW9C\",\n  \"url\": \"https://go.oncehub.com/.S617NW9C\",\n  \"creation_time\": \"2023-12-08T10:21:01Z\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"S617NW9C"},"url":{"type":"string","example":"https://go.oncehub.com/.S617NW9C"},"creation_time":{"type":"string","example":"2023-12-08T10:21:01Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"Bad Request\",\n  \"message\": \"This master page is deleted: 'BP-EHM6JU50Q3'\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"Bad Request"},"message":{"type":"string","example":"This master page does not allow creation of one time links: 'BP-1234'"},"param":{"type":"string","example":"id"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such master page: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such master page: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/users":{"get":{"summary":"List all users","description":"Returns a list of all users in your account","operationId":"list-all-users","parameters":[{"name":"email","in":"query","description":"Filter by the user's email address","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"id\": \"USR-FSD423423\",\n      \"object\": \"user\",\n      \"first_name\": \"Andrea\",\n      \"last_name\": \"Hartie\",\n      \"email\": \"[email protected]\",\n      \"status\": \"active\",\n      \"role_name\": \"Member\",\n\t\t\t\"timezone\": \"America/Chicago\"\n    },\n    {...},\n    {...}\n  ]\n}\n"}}}}}},"deprecated":false}},"/users/{id}":{"get":{"summary":"Get a single user","description":"Returns a single user by ID","operationId":"get-a-single-user","parameters":[{"name":"id","in":"path","description":"ID of the user","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"id":"USR-FSD423423","object":"user","first_name":"Andrea","last_name":"Hartie","email":"[email protected]","status":"active","role_name":"Member","timezone":"America/Chicago"}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"USR-FSD423423"},"object":{"type":"string","example":"user"},"first_name":{"type":"string","example":"Andrea"},"last_name":{"type":"string","example":"Hartie"},"email":{"type":"string","example":"[email protected]"},"status":{"type":"string","example":"active"},"role_name":{"type":"string","example":"Member"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such user: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such user: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false},"delete":{"description":"","operationId":"delete_users{id}","responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","description":"ID of the user"},"deleted":{"type":"string","description":"A boolean flag, always `true`, confirming the deletion was successful."}},"type":"object","required":["id","deleted"]},"examples":{"New Example":{"summary":"New Example","value":{"id":"USR-FSD423423","deleted":true}}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"ID of the user"}]}},"/teams":{"get":{"summary":"List all teams","description":"Returns a list of all teams in your account","operationId":"list-all-teams","parameters":[{"name":"user","in":"query","description":"Return all teams that the provided user is a member of.","schema":{"type":"string"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"object\": \"team\",\n      \"id\": \"TM-GCJU8DLBTPY1\",\n      \"name\": \"Sales\"\n    },\n    {...},\n    {...}\n  ]\n}\n"}}}}}},"deprecated":false}},"/teams/{id}":{"get":{"summary":"Get a single team","description":"Returns a single team by ID","operationId":"get-a-single-team","parameters":[{"name":"id","in":"path","description":"ID of the team.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"team\",\n  \"id\": \"TM-GCJU8DLBTPY1\",\n  \"name\": \"Sales\"\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"team"},"id":{"type":"string","example":"TM-GCJU8DLBTPY1"},"name":{"type":"string","example":"Sales"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such team: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such team: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/contacts":{"get":{"summary":"List all contacts","description":"List all contacts in your account","operationId":"list-all-contacts","parameters":[{"name":"email","in":"query","description":"Filter by the contact's email address","schema":{"type":"string"}},{"name":"creation_time.lt","in":"query","description":"Return contacts with creation time less than the given date.","schema":{"type":"string","format":"date"}},{"name":"last_updated_time.gt","in":"query","description":"Return contacts with last updated time greater than the given date.","schema":{"type":"string","format":"date"}},{"name":"last_updated_time.lt","in":"query","description":"Return contacts with last updated time less than the given date.","schema":{"type":"string","format":"date"}},{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"creation_time.gt","in":"query","description":"Return contacts with creation time greater than the given date.","schema":{"type":"string","format":"date"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"object\": \"contact\",\n      \"id\": \"CTC-J4FR05BKEW\",\n      \"creation_time\": \"2020-03-22T09:48:48Z\",\n      \"last_updated_time\": \"2020-03-22T09:48:48Z\",\n      \"last_interacted_time\": \"\",\n      \"owner\": \"USR-FSD423423\",\n      \"status\": \"Qualified\",\n      \"city\": \"Carrie Customer\",\n      \"company_size\": null,\n      \"company\": null,\n      \"country\": null,\n      \"email\": \"[email protected]\",\n      \"employees\": 1,\n      \"first_name\": null,\n      \"has_consent\": false,\n      \"job_title\": null,\n      \"last_name\": null,\n      \"mobile_phone\": null,\n      \"phone\": null,\n      \"post_code\": null,\n      \"salutation\": null,\n      \"state\": null,\n      \"street_address\": null,\n      \"terms_of_sevice\": null,\n      \"timezone\": \"America/New_York\",\n      \"custom_fields\": [\n        { \"name\": \"resume\", \"value\": null },\n        { \"name\": \"contact_second_number\", \"value\": null }\n      ]\n    }\n    {...},\n    {...}\n  ]\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"last_updated_time.gt cannot be later than last_updated_time.lt\",\n  \"param\": \"last_updated_time.gt\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"creation_time.gt cannot be later than creation_time.lt"},"param":{"type":"string","example":"creation_time.gt"}}}}}}},"deprecated":false}},"/contacts/{id}":{"get":{"summary":"Get a single contact","description":"Get a single contact","operationId":"get-a-single-contact","parameters":[{"name":"id","in":"path","description":"ID of the contact","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"object":"contact","id":"CTC-J4FR05BKEW","creation_time":"2020-03-22T09:48:48Z","last_updated_time":"2020-03-22T09:48:48Z","last_interacted_time":"","owner":"USR-FSD423423","status":"Qualified","city":"Carrie Customer","company_size":null,"company":null,"country":null,"email":"[email protected]","employees":1,"first_name":null,"has_consent":false,"job_title":null,"last_name":null,"mobile_phone":null,"phone":null,"post_code":null,"salutation":null,"state":null,"street_address":null,"terms_of_sevice":null,"timezone":"America/New_York","custom_fields":[{"name":"resume","value":null},{"name":"contact_second_number","value":null}]}}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"contact"},"id":{"type":"string","example":"CTC-J4FR05BKEW"},"creation_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"last_updated_time":{"type":"string","example":"2020-03-22T09:48:48Z"},"last_interacted_time":{},"owner":{"type":"string","example":"USR-FSD423423"},"city":{"type":"string","example":"Carrie Customer"},"company_size":{},"company":{},"country":{},"email":{"type":"string","example":"[email protected]"},"employees":{"type":"integer","example":1,"default":0},"first_name":{},"has_consent":{},"job_title":{},"last_name":{},"mobile_phone":{},"phone":{},"post_code":{},"salutation":{},"state":{},"street_address":{},"terms_of_sevice":{},"timezone":{"type":"string","example":"America/New_York"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"resume"},"value":{}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such contact: '123'\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such contact: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false},"delete":{"summary":"Delete a contact","description":"Delete a contact","operationId":"delete-a-contact","parameters":[{"name":"id","in":"path","description":"ID of the contact","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"id\": \"CTC-J4FR05BKEW\",\n  \"deleted\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"CTC-J4FR05BKEW"},"deleted":{"type":"boolean","example":true,"default":true}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such contact: '123'\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such contact: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/webhooks":{"post":{"summary":"Create a webhook","description":"Creates a webhook subscription.","operationId":"create-a-webhook","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL for receiving POST messages from OnceHub"},"name":{"type":"string","description":"Unique name for your Webhook subscription. This name is only used by you for reference."},"events":{"type":"array","description":"An array of Booking lifecycle events that will trigger the Webhook.","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Example response":{"value":"{\n  \"object\": \"webhook\",\n  \"id\": \"WHK-7JD9LBVZTQ\",\n  \"api_version\": \"v2\",\n  \"name\": \"New booking webhook\",\n  \"url\": \"https://mywebsite.com/webhooks/booking\",\n  \"events\": [\"booking.completed\", \"booking.rescheduled\"],\n  \"creation_time\": \"2020-09-06T20:57:17.467Z\",\n  \"secret\": \"d7686b8c83f04913929079aeae40189e\"\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"webhook"},"id":{"type":"string","example":"WHK-7JD9LBVZTQ"},"api_version":{"type":"string","example":"v2"},"name":{"type":"string","example":"New booking webhook"},"url":{"type":"string","example":"https://mywebsite.com/webhooks/booking"},"events":{"type":"array","items":{"type":"string","example":"booking.completed"}},"creation_time":{"type":"string","example":"2020-09-06T20:57:17.467Z"},"secret":{"type":"string","example":"d7686b8c83f04913929079aeae40189e"}}}}}},"409":{"description":"409","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"A webhook subscription with this name already exists: 'New Bookings'\",\n  \"param\": \"name\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"A webhook subscription with this name already exists: 'New Bookings'"},"param":{"type":"string","example":"name"}}}}}}},"deprecated":false},"get":{"summary":"List all webhooks","description":"Returns a list of your webhook subscriptions, sorted by creation date.","operationId":"list-all-webhooks","parameters":[{"name":"before","in":"query","description":"A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, starting with `OBJ-XXXX`, your subsequent call can include `before=OBJ-XXXX` in order to fetch the previous page of the list.","schema":{"type":"string"}},{"name":"after","in":"query","description":"A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 30 objects, ending with `OBJ-XXXX`, your subsequent call can include `after=OBJ-XXXX` in order to fetch the next page of the list.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Determines the number of objects that will be returned on each page. Defaults to 10 if not specified and has a maximum limit of 100 objects per page.","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Example response":{"value":"{\n  \"object\": \"list\",\n  \"data\": [\n    {\n      \"object\": \"webhook\",\n      \"id\": \"WHK-7JD9LBVZTQ\",\n      \"api_version\": \"v2\",\n      \"name\": \"New booking webhook\",\n      \"url\": \"https://mywebsite.com/webhooks/booking\",\n      \"events\": [\"booking.completed\", \"booking.rescheduled\"],\n      \"creation_time\": \"2020-09-06T20:57:17.467Z\"\n    },\n    {...},\n    {...}\n  ]\n}\n"}}}}}},"deprecated":false}},"/webhooks/{id}":{"get":{"summary":"Get a single webhook","description":"Returns a single webhook subscription by ID.","operationId":"get-a-single-webhook","parameters":[{"name":"id","in":"path","description":"ID of the webhook","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Example response":{"value":"{\n  \"object\": \"webhook\",\n  \"id\": \"WHK-7JD9LBVZTQ\",\n  \"api_version\": \"v2\",\n  \"name\": \"New booking webhook\",\n  \"url\": \"https://mywebsite.com/webhooks/booking\",\n  \"events\": [\"booking.completed\", \"booking.rescheduled\"],\n  \"creation_time\": \"2020-09-06T20:57:17.467Z\"\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"webhook"},"id":{"type":"string","example":"WHK-7JD9LBVZTQ"},"api_version":{"type":"string","example":"v2"},"name":{"type":"string","example":"New booking webhook"},"url":{"type":"string","example":"https://mywebsite.com/webhooks/booking"},"events":{"type":"array","items":{"type":"string","example":"booking.completed"}},"creation_time":{"type":"string","example":"2020-09-06T20:57:17.467Z"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such webhook: '123'\",\n  \"param\": \"id\"\n}\n"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such webhook: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false},"delete":{"summary":"Delete a webhook","description":"Deletes a single webhook subscription by ID.","operationId":"delete-a-webhook","parameters":[{"name":"id","in":"path","description":"ID of the webhook","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Example response":{"value":"{\n  \"id\": \"WHK-7JD9LBVZTQ\",\n  \"deleted\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"WHK-7JD9LBVZTQ"},"deleted":{"type":"boolean","example":true,"default":true}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n  \"type\": \"invalid_request_error\",\n  \"message\": \"No such webhook: '123'\",\n  \"param\": \"id\"\n}"}},"schema":{"type":"object","properties":{"type":{"type":"string","example":"invalid_request_error"},"message":{"type":"string","example":"No such webhook: '123'"},"param":{"type":"string","example":"id"}}}}}}},"deprecated":false}},"/new-endpoint":{"get":{"description":"","operationId":"get_new-endpoint","responses":{"200":{"description":""}},"parameters":[]}},"/users/{id}/scheduling-availability":{"get":{"description":"","operationId":"get_new-endpoint-1","responses":{"200":{"description":"","content":{"application/json":{"examples":{"New Example":{"summary":"New Example","value":""},"Result":{"summary":"Result","value":{"object":"schedule","timezone":"America/Chicago","weekly":[{"day":"Monday","working_hours":[{"start_time":"09:00","end_time":"12:00","locations":[{"type":"online_dynamic_link","value":"google_meet","id":null}]},{"start_time":"13:00","end_time":"17:00","locations":[{"type":"online_dynamic_link","value":"zoom","id":null},{"type":"in_person_by_host","value":"123 Office Street, New York, NY","id":"ADD-K8E9X"}]}]},{"day":"Wednesday","working_hours":[{"start_time":"10:00","end_time":"15:00","locations":[{"type":"online_static_link","value":"https://meet.example.com/team-meeting","id":null}]}]}],"overrides":[{"date":"2025-11-27","day":"Thursday","working_hours":[]},{"date":"2025-12-24","day":"Wednesday","working_hours":[{"start_time":"09:00","end_time":"12:00","locations":[{"type":"online_dynamic_link","value":"google_meet","id":null}]}]}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"New Example 1":{"value":{"type":"invalid_request_error","message":"Received unknown parameter: start_date","param":"start_date"}},"Result 1":{"value":{"type":"invalid_request_error","message":"Invalid date format for overrides_start_time. Expected format: YYYY-MM-DD","param":"overrides_start_time"},"summary":"Result 1"}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"ID of the user"}]},"patch":{"description":"","operationId":"patch_users{id}scheduling-availability","responses":{"200":{"description":"","content":{"application/json":{"examples":{"Example":{"summary":"Example","value":{"object":"schedule","timezone":"America/Chicago","weekly":[{"day":"Monday","working_hours":[{"start_time":"10:00","end_time":"16:00","locations":[{"type":"online_dynamic_link","value":"zoom","id":null}]}]},{"day":"Wednesday","working_hours":[{"start_time":"10:00","end_time":"15:00","locations":[{"type":"online_static_link","value":"https://meet.example.com/team-meeting","id":null}]}]},{"day":"Saturday","working_hours":[]}],"overrides":[{"date":"2025-12-25","day":"Thursday","working_hours":[{"start_time":"10:00","end_time":"12:00","locations":[{"type":"online_dynamic_link","value":"google_meet","id":null}]}]}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"Response":{"value":{"type":"invalid_request_error","message":"availability range is overlapping: '09:00-11:00'","param":"weekly.working_hours"},"summary":"Response"},"Response 1":{"value":{"type":"invalid_request_error","message":"start time should be multiple of 15: '09:05'","param":"weekly.working_hours.start_time"},"summary":"Response 1"},"Response 2":{"value":{"type":"invalid_request_error","message":"Date cannot be in the past: '2024-01-01'","param":"overrides.date"},"summary":"Response 2"},"New Example":{"value":{"type":"invalid_request_error","message":"Duplicate entry for day or date: 'Monday'","param":"weekly"}}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"examples":{"New Example":{"value":{"type":"invalid_request_error","message":"You can set either online_dynamic_link or online_static_link","param":"weekly.working_hours.locations"}}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"weekly":{"type":"array","items":{"properties":{"day":{"type":"string","description":"The day of the week (e.g., \"Monday\", \"Tuesday\"). Must be a valid, case-sensitive day name. Duplicate days are not allowed."},"working_hours":{"type":"array","description":"An array of time slot objects for the day. To clear all availability for a day, provide an empty array (`[]`). This field cannot be `null`. Time slots for a single day cannot overlap.","items":{"properties":{"start_time":{"type":"string","description":"The start time of an availability slot in `HH:MM` format. The time must be a multiple of 15 minutes."},"end_time":{"type":"string","description":"The end time of an availability slot in `HH:MM` format. Must be a multiple of 15 minutes and occur after the start_time."},"locations":{"type":"array","items":{"properties":{"type":{"type":"string","description":"The type of location. Valid options are: `in_person_by_host`, `online_dynamic_link`, `online_static_link`, `phone_by_guest`. Duplicate types are not allowed within the same slot."},"id":{"type":"string","description":"The unique identifier for a physical address. This field is required and only used when the type is `in_person_by_host`."},"value":{"type":"string","description":"The static URL for an online meeting. This field is required and only used when the type is `online_static_link`."}},"type":"object","required":["type"]},"description":"An array of location objects available for the time slot. Can be empty. You cannot mix `online_dynamic_link` and `online_static_link` types in the same slot."}},"type":"object","required":["start_time","end_time","locations"]}}},"type":"object","required":["day","working_hours"]},"description":"An array of objects, each defining the full availability for a specific day of the week. Any day provided will have its schedule completely overwritten."},"overrides":{"type":"array","items":{"properties":{"date":{"type":"string","description":"The specific date for the override in `YYYY-MM-DD` format. The date cannot be in the past. Duplicate dates are not allowed."},"working_hours":{"type":"array","items":{"properties":{"start_time":{"type":"string","description":"The start time of an availability slot for the override date in `HH:MM` format. The time must be a multiple of 15 minutes."},"end_time":{"type":"string","description":"The end time of an availability slot for the override date in `HH:MM` format. Must be a multiple of 15 minutes and occur after the `start_time`."},"locations":{"type":"array","description":"An array of location objects available for the time slot on the override date. Can be empty.","items":{"properties":{"type":{"type":"string","description":"The type of location for the override slot. Valid options are: `in_person_by_host`, `online_dynamic_link`, `online_static_link`, `phone_by_guest`."},"id":{"type":"string","description":"The unique identifier for a physical address. This field is required and only used when the type is `in_person_by_host`."},"value":{"type":"string","description":"The static URL for an online meeting. This field is required and only used when the type is `online_static_link`."}},"type":"object","required":["type"]}}},"type":"object","required":["start_time","locations","end_time"]},"description":"An array of time slot objects for the specific date. To make a user unavailable for the entire date, provide an empty array (`[]`). To **delete** an existing override for a date, set this value to `null`."}},"type":"object","required":["working_hours"]},"description":"An array of objects, each defining an exception for a specific date. Any date provided will have its override schedule completely overwritten."}},"type":"object"}}}}}},"/users/{id/scheduling-availability":{"get":{"description":"","operationId":"get_new-endpoint-1","responses":{"200":{"description":""}},"parameters":[]}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":false},"x-readme-fauxas":true}