Appointment Type Drop-Downs

The Appointment Type Drop-Downs feature will allow the user to view the list of types of appointments configured for a practice. In general, use of patient appointment reasons are preferred to use of appointment types; this API is provided for those partners with special requirements that preclude the use of patient appointment reasons.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get list of schedulable appointment metadata
GET
/v1/{practiceid}/appointments/appointmenttypedropdown/mapping

Retrieve the types of appointments configured in the system

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
appointmenttypeid integer ID of the Appointment.
showenabledonly boolean By default we show all appointmenttypes available to provider/department combination Setting this flag to true and giving either provider, appointmenttypeid, departmentid, or any combination will show whats actually configured in the appointmenttypes drop down table for the given parameters.
departmentid integer Id of the Department.
providerid integer ID of the Provider.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmenttypeid integer ID of the AppointmentType.
appointmenttypename string NAme of the AppointmentType
departmentid integer ID of the Department
departmentname string Name of the Department.
providerid integer Id of the Provider.
providername string Name of the Provider
Example Code