get Appointment Categories Id
GET {{baseUrl}}/appointment_categories/:id?subdomain={{subdomain}}&location_id={{location_id}}&include[]=<string>&include[]=<string>
Get an appointment category by ID
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | Id of the associated location, required when appointment categories are location specific | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e","descriptors":[{"id":"\u003cinteger\u003e","descriptor_type":"\u003cstring\u003e","name":"\u003cstring\u003e","code":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","data":"\u003cobject\u003e","active":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","descriptor_type":"\u003cstring\u003e","name":"\u003cstring\u003e","code":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","data":"\u003cobject\u003e","active":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e"}],"providers":[{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","display_name":"\u003cstring\u003e","npi":"\u003cstring\u003e","locations":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"provider_requestables":[{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","display_name":"\u003cstring\u003e","npi":"\u003cstring\u003e","locations":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"name":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"institution_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"street_address_2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"state":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"zip_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"created_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"updated_at":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone_number":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"foreign_id_type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tz":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"last_sync_time":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"insert_appt_client":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"map_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"set_availability_by_operatory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"inactive":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"provider_requestables":[{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"location_id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}],"operatories":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","display_name":"\u003cstring\u003e","active":"\u003cboolean\u003e","static_image_url":"\u003cstring\u003e","profile_url":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","display_name":"\u003cstring\u003e","active":"\u003cboolean\u003e","static_image_url":"\u003cstring\u003e","profile_url":"\u003cstring\u003e"}]},"count":"\u003cinteger\u003e"}