The API has predictable, resource-oriented URLs, and uses HTTP response codes to
indicate API errors. All API access is over HTTPS. All data is received as JSON, including errors.
Data: Please URL encode all parameter values.
The API requires an API token to work.
Please sign in or
create an account to receive your
accounts API tokens.
Returns a list of scheduled appointments. The appointments are sorted by upcoming first.
$ curl https://appointmentthing.com/api/v1/appointments/list/?token=token&type=type
Returns
{"meta":{"code":"200"},"users":[{"id":"1","username":"email@domain.com","fullname":"John Doe","meetingtimezone":"America/Phoenix"},{"id":"2","username":"email@domain.com","fullname":"Jane Doe","meetingtimezone":"America/Los_Angeles"}],"appointments":[[{"appointment_id":"16212848967523S8CrJUHfF1at","appointment_unique":"16212848967523S8CrJUHfF1at","account_user_id":"1","account_user_name":"email@domain.com","account_name":"John Doe","date_start":"2021-05-31 08:00:00","date_start_unix":"1622473200","date_end":"2021-05-31 08:30:00","date_end_unix":"1622475000","date_timezone":"America/Phoenix","user_name":"Bob Doe","user_email":"bob.doe@domain.com","user_phone":"(555) 555-5555","user_phone_country":"1","user_guests":"","changed_by":null,"changed_date_unix":null,"canceled_by":"","canceled_date_unix":"1621535960","status":"1","color":"1","meeting_name":"Appointment Name","duration":"30"}]]}
code
- 200
appointments
- List of appointments ordered by type of upcoming or past
users
- array key that returns a list of appointments & users.
code
- 400error_message
- detailed error message.
Returns details about an appointment.
$ curl https://appointmentthing.com/api/v1/appointments/appointment/?token=token&appointment_id=appointment_id
Returns
{"meta":{"code":"200"},"appointment":[{"id":"1","type":"Type","type_name":"Type Name","type_title":"30 minute meeting","type_custom_url":"custom_url","type_picture":"","type_intro":"intro","type_details":"","type_duration":"30","apptid":"app_id","date_start":"2021-05-03 09:00:00","date_start_unix":"1620057600","date_end":"2021-05-03 09:30:00","date_end_unix":"1620059400","date_timezone":"America/Phoenix","location":null,"location_details":null,"location_type":null,"location_json":null,"user_timezone":null,"user_timeformat":null,"user_name":"User Name","user_email":"user_email@appointmentthing.com","user_phone":"","user_phone_country":"1","user_guests":"","form_data":"","form_details":"","form_meeting_dump":"","changed_by":null,"chnaged_by_type":null,"changed_reason":null,"changed_date":null,"changed_date_unix":null,"canceled_by":null,"canceled_by_type":null,"canceled_reason":null,"canceled_date":null,"canceled_date_unix":null,"status":"1","active":"true","create_date":"2021-03-08 21:00:05","update_date":"2021-05-03 07:00:27"}]}
code
- 200
appointment
- Appointment details for the parameter appointment_id
code
- 400error_message
- detailed error message.
Reschedules an appointment. Returns a rescheduled status.
$ curl https://appointmentthing.com/api/v1/appointments/reschedule/?token=token&appointment_id=appointment_id&start=start&end=end
Returns
{
"meta": {
"code": "200"
},
"id": "1",
"status": "rescheduled"
}
code
- 200
code
- 400error_message
- detailed error message.
Cancels an appointment. Returns a canceled status.
$ curl https://appointmentthing.com/api/v1/appointments/cancel/?token=token&appointment_id=appointment_id
Returns
{"meta":{"code":"200"},"id":"1","status":"canceled"}
code
- 200
code
- 400error_message
- detailed error message.
Returns a list of appointment types. The appointments types are sorted by newest first.
$ curl https://appointmentthing.com/api/v1/appointments/types/list/?token=token
Returns
{"meta":{"code":"200"},"total":1,"types":[{"id":"1","userid":"1","fullname":"John Doe","username":"email@domain.com","unique":"uh8523","custom_url":null,"color":"1","meeting_name":"meeting_name","meeting_title":"meeting_title","meeting_picture":"1618347928046.png","meeting_intro":"meeting_intro","meeting_locations":[{"location_id":"1","meeting_type_id":"meeting_type_id","location_type":"in-person","location_details":"location_details","location_additional_details":"location_additional_details","create_date":"2021-04-05 20:48:37","modify_date":"2021-04-05 20:48:37"},{"location_id":"2","meeting_type_id":"meeting_type_id","location_type":"custom-location","location_details":"location_details","location_additional_details":"location_additional_details","create_date":"2021-04-13 19:37:49","modify_date":"2021-04-13 19:37:49"}],"form_fields":[{"id":"1","type":"text","text":"Name","extra_text1":null,"extra_text2":null,"mandatory_field":"true","system_field":"true","field_option1":null,"field_option2":null,"field_option3":null,"field_option4":null,"field_option5":null,"field_option6":null,"field_option7":null,"field_option8":null,"field_option9":null,"field_option10":null,"field_option11":null,"field_option12":null,"field_option13":null,"field_option14":null,"field_option15":null},{"id":"2","type":"email","text":"Email","extra_text1":null,"extra_text2":null,"mandatory_field":"true","system_field":"true","field_option1":null,"field_option2":null,"field_option3":null,"field_option4":null,"field_option5":null,"field_option6":null,"field_option7":null,"field_option8":null,"field_option9":null,"field_option10":null,"field_option11":null,"field_option12":null,"field_option13":null,"field_option14":null,"field_option15":null}],"meeting_details":"","availablity_general":"{\"mon\":\"0900-1900\",\"tue\":\"0900-1900\",\"wed\":\"0900-1900\",\"thu\":\"0900-1900\",\"fri\":\"0900-1900\",\"sat\":\"\",\"sun\":\"\"}","schedule_window":"1","schedule_from":"2021-01-22","schedule_to":"2021-02-22","buffer_before":"5","buffer_after":"10","booking_before":"0","booking_intervals":"10","duration":"60","visible":"true","create_date":"2021-03-31 23:38:29","modify_date":"2021-06-01 18:12:29"}]}
code
- 200
code
- 400error_message
- detailed error message.
Creates an appointment type. Returns the appointment type created.
$ curl https://appointmentthing.com/api/v1/appointments/types/create/?token=token&user_id=user_id&meetingname=meetingname&meetingtitle=meetingtitle&customurl=customurl&meetingintro=meetingintro&meetinglocations=meetinglocations&duration=duration&timezone=timezone&timeformat=timeformat&availability_general=availability_general&schedule_window=schedule_window&schedule_rolldays=schedule_rolldays&schedule_datefrom=schedule_datefrom&schedule_dateto=schedule_dateto&buffer_before=buffer_before&buffer_after=buffer_after&book_before=book_before&booking_intervals=booking_intervals&setting_calendar_firstday=setting_calendar_firstday&visible=visible¬iwsenabled=notiwsenabled¬i1enabled=noti1enabled¬i1min=noti1min¬i2enabled=noti2enabled¬i2min=noti2min¬i3enabled=noti3enabled¬i3min=noti3min&paymenttype=paymenttype&paymentamount=paymentamount&paymentcurrency=paymentcurrency&paymentterms=paymentterms
Returns
{"meta":{"code":"200"},"appointment_type_id":"1","appointment_type":{"id":"1","uniquekey":"uh8522","customurl":"custom-url","color":"1","meetingname":"meetingname","meetingtitle":"meetingtitle","meetingintro":"","meetinglocations":"","timeformat":"12","meetingdetails":"","availability_general":"{\"mon\":\"0900-1900\",\"tue\":\"0900-1900\",\"wed\":\"0900-1900\",\"thu\":\"0900-1900\",\"fri\":\"0900-1900\",\"sat\":\"\",\"sun\":\"\"}","duration":"30","create_date":"2021-06-01 19:27:28","modify_date":"2021-06-01 19:27:29","timezone":"America/Phoenix","schedule_window":"1","schedule_days":"60","buffer_before":"0","visible":"true","bufferafter":"0","bookingbefore":"0","scheduleto":null,"schedulefrom":null,"bookingintervals":"30"}}
code
- 200
code
- 400error_message
- detailed error message.
Save an appointment type. Returns the appointment type saved.
$ curl https://appointmentthing.com/api/v1/appointments/types/save/?token=token&type_id=type_id&meetingname=meetingname&meetingtitle=meetingtitle&customurl=customurl&meetingintro=meetingintro&meetinglocations=meetinglocations&duration=duration&timezone=timezone&timeformat=timeformat&availability_general=availability_general&schedule_window=schedule_window&schedule_rolldays=schedule_rolldays&schedule_datefrom=schedule_datefrom&schedule_dateto=schedule_dateto&buffer_before=buffer_before&buffer_after=buffer_after&book_before=book_before&booking_intervals=booking_intervals&setting_calendar_firstday=setting_calendar_firstday&visible=visible¬iwsenabled=notiwsenabled¬i1enabled=noti1enabled¬i1min=noti1min¬i2enabled=noti2enabled¬i2min=noti2min¬i3enabled=noti3enabled¬i3min=noti3min&paymenttype=paymenttype&paymentamount=paymentamount&paymentcurrency=paymentcurrency&paymentterms=paymentterms
Returns
{"meta":{"code":"200"},"status":"updated","appointment_type":{"id":"1","uniquekey":"uh8523","customurl":null,"color":"1","meetingname":"meetingname","meetingtitle":"meetingtitle","meetingintro":"meetingintro","meetinglocations":"meetinglocations","timeformat":"24","meetingdetails":"","availability_general":"{\"mon\":\"0900-1900\",\"tue\":\"0900-1900\",\"wed\":\"0900-1900\",\"thu\":\"0900-1900\",\"fri\":\"0900-1900\",\"sat\":\"\",\"sun\":\"\"}","duration":"60","timezone":"America/Phoenix","schedule_window":"1","schedule_days":"60","buffer_before":"5","visible":"true","bufferafter":"10","bookingbefore":"0","scheduleto":"2021-02-22","schedulefrom":"2021-01-22","bookingintervals":"10","create_date":"2021-03-31 23:38:29","modify_date":"2021-06-01 18:12:29"}}
code
- 200
appointment_type
- Appointment type details for the parameter appointment_id
code
- 400error_message
- detailed error message.
Deletes an appointment type. Returns a deletion status.
$ curl https://appointmentthing.com/api/v1/appointments/types/delete/??token=token&type_id=type_id
Returns
{
"meta": {
"code": "200"
},
"type": {
"id": "1",
"status": "deleted"
}
}
code
- 200
code
- 400error_message
- detailed error message.
Lists of all appointment type locations.
$ curl https://appointmentthing.com/api/v1/appointments/locations/list/?token=token
Returns
{"meta":{"code":"200"},"total":2,"types":[{"location_id":"1","userid":"1","fullname":"John Doe","username":"email@domain.com","location_type":"custom-location","meeting_type":"Appointment Type","location_details":"Location Details","location_additional_details":"","location_visibility":"1","create_date":"2021-03-31 23:38:27","modify_date":"2021-03-31 23:38:27"},{"location_id":"2","userid":"2","fullname":"John Doe","username":"email@domain.com","location_type":"custom-location","meeting_type":"Appointment Type","location_details":"Location Details","location_additional_details":"","location_visibility":"2","create_date":"2021-04-05 20:48:37","modify_date":"2021-04-05 20:48:37"}]}
code
- 200
code
- 400error_message
- detailed error message.
Lists of all availability for an account.
$ curl https://appointmentthing.com/api/v1/appointments/get/availability/?token=token&meetingtype=meetingtype&timezone=timezone&timeformat=timeformat&calendar_date=calendar_date
Returns
{"meta":{"code":"200"},"availabilty":[{"month":"05","day":"26","year":"2021","label":"Wednesday, May 26th","available":3,"unavailable":"0","total":3,"date":"2021-05-26"}],"unavailable":[{"from_unix":"1622138400","to_unix":"1622140200"}],"available":[{"from_unix":"1622075400","to_unix":"1622077200"}]}
code
- 200
code
- 400error_message
- detailed error message.
List of all available account users.
$ curl https://appointmentthing.com/api/v1/appointments/users/list/?token=token
Returns
{"meta":{"code":"200"},"total":1,"users":[{"id":"1","username":"Username","fullname":"John Doe","timezone":"America/Phoenix","customurl":"custom-url","headline":"Headline","description":"Description","time_format":"12","phone_country":"1","phone":"555-555-5555","phony_notify_minutes":"15","phone_active":"true","week_day_begins_on":"Monday"}]}
code
- 200
code
- 400error_message
- detailed error message.
Lists of all available time zones.
$ curl https://appointmentthing.com/api/v1/appointments/timezones/list/?token=token
Returns
{"meta":{"code":"200"},"data":[{"id":0,"label":"Pacific\/Midway","local_time":"2021-05-26 13:20:49","is_dst":"0","gmt_offset":"-39600","gmt_diff":"-11:00","tzid_abbr":"SST","offset":"-39600"},{"id":1,"label":"Pacific\/Pago_Pago","local_time":"2021-05-26 13:20:49","is_dst":"0","gmt_offset":"-39600","gmt_diff":"-11:00","tzid_abbr":"SST","offset":"-39600"},{"id":2,"label":"Pacific\/Honolulu","local_time":"2021-05-26 14:20:49","is_dst":"0","gmt_offset":"-36000","gmt_diff":"-10:00","tzid_abbr":"HST","offset":"-36000"},{"id":3,"label":"Pacific\/Honolulu","local_time":"2021-05-26 14:20:49","is_dst":"0","gmt_offset":"-36000","gmt_diff":"-10:00","tzid_abbr":"HST","offset":"-36000"},{"id":4,"label":"Pacific\/Honolulu","local_time":"2021-05-26 14:20:49","is_dst":"0","gmt_offset":"-36000","gmt_diff":"-10:00","tzid_abbr":"HST","offset":"-36000"},{"id":5,"label":"Pacific\/Honolulu","local_time":"2021-05-26 14:20:49","is_dst":"0","gmt_offset":"-36000","gmt_diff":"-10:00","tzid_abbr":"HST","offset":"-36000"},{"id":6,"label":"Pacific\/Honolulu","local_time":"2021-05-26 14:20:49","is_dst":"0","gmt_offset":"-36000","gmt_diff":"-10:00","tzid_abbr":"HST","offset":"-36000"},{"id":7,"label":"America\/Adak","local_time":"2021-05-26 15:20:49","is_dst":"1","gmt_offset":"-32400","gmt_diff":"-09:00","tzid_abbr":"HDT","offset":"-32400"},{"id":8,"label":"America\/Adak","local_time":"2021-05-26 15:20:49","is_dst":"1","gmt_offset":"-32400","gmt_diff":"-09:00","tzid_abbr":"HDT","offset":"-32400"}]}
code
- 200
code
- 400error_message
- detailed error message.