6/29 NexHealth API

Number of APIs: 58

Welcome to the developer hub and documentation for NexHealth API. This section of guide describes the operations, response parameters, request parameters, and parameter constraints related to User API. The term Operations refer to functions or methods. The operations are included in requests and send to the web server. Each operation performs a different action or a query on database.

Contact Support: Name: NexHealth Email: info@nexhealth.com

  1. availabilities-{id} - get Availabilities Id GET {{baseUrl}}/availabilities/:id?subdomain={{subdomain}}&include[]=<string>&include[]=<string>

  2. conversations - post Conversations POST {{baseUrl}}/conversations?subdomain={{subdomain}}&location_id={{location_id}}

  3. institutions - get Institutions GET {{baseUrl}}/institutions

  4. operatories - get Operatories GET {{baseUrl}}/operatories?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=20&search_name=<string>&foreign_id=<string>&updated_since=<dateTime>&include[]=["appt_categories"]&include[]=["appt_categories"]

  5. patient recalls - get Patient Recalls GET {{baseUrl}}/patient_recalls?subdomain={{subdomain}}&page=1&per_page=20&location_id={{location_id}}&recall_id=<integer>&patient_id=<integer>&foreign_id=<string>&updated_since=<dateTime>&due_after=<dateTime>

  6. appointment categories-{id} - get Appointment Categories Id GET {{baseUrl}}/appointment_categories/:id?subdomain={{subdomain}}&location_id={{location_id}}&include[]=<string>&include[]=<string>

  7. appointments-{id} - get Appointments Id Appointment Descriptors GET {{baseUrl}}/appointments/:id/appointment_descriptors?subdomain={{subdomain}}&descriptor_type=<string>

  8. appointments - get Appointments GET {{baseUrl}}/appointments?subdomain={{subdomain}}&location_id={{location_id}}&start=2022-01-01&end=2022-12-31&page=1&per_page=20

  9. availabilities - get Availabilities GET {{baseUrl}}/availabilities?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=20&include[]=<string>&include[]=<string>&provider_id=<integer>&operatory_id=<integer>&active=true&ignore_past_dates=false

  10. locations - get Locations GET {{baseUrl}}/locations?subdomain={{subdomain}}&inactive=<boolean>&foreign_id=<string>