Search Appointment Slots

<Warning>This is a beta endpoint. Breaking changes may occur without notice, use at your own risk.</Warning>

Generate appointment slot suggestions for a set of available providers in the given time range.

Slots are based on working-type shifts in the period, filtered & ranked by the given requirements/preferences.

On ranking,

  • Skills are ranked by the closest match. For example, a skill requirement for specialty X will rank providers with only specialty X highly, and providers with multiple specialties including X lower.
  • Slots which do not create unusable gaps are preferred.

Skills are the primary mechanism for selecting providers, see Using Skills for more information.

post/v1/appointments/slots

Request

  • Base URL
    https://app.untetherlabs.com/api
  • URL
    https://app.untetherlabs.com/api/v1/appointments/slots
  • Auth
    HTTP bearer

Request body

appointmentTypeIdstring required
startDatestring required
endDatestring required
limitnumber

Maximum number of slots to return

Example request

{
  "startDate": "2024-11-20T07:43:34+0000",
  "endDate": "2024-11-20T07:43:34+0000"
}

Response

Example response

{
  "results": [
    {
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.