View appointment types
GET {{baseUrl}}/appointment_types?subdomain={{subdomain}}&location_id={{location_id}}&include[]=<string>&include[]=<string>
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 types are location specific and when including sub-resources | |
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":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"provider_requestables":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"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":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"provider_requestables":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"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"},{"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"}]},{"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":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"provider_requestables":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"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":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"provider_requestables":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"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"},{"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"}]}],"count":"\u003cinteger\u003e"}