Untether LabsDevelopers

Search Appointment Slots

Beta
posthttps://app.untetherlabs.com/api/v1/appointments/slots
This is a beta endpoint. Breaking changes may occur without notice, use at your own risk.

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.

Request body#

appointmentTypeIdstring
Required
startDatestring
Required
endDatestring
Required
requirementsobject

Hard filters for possible slots

Show properties
providerIdsstring[]
skillSkillRequirement
Option 1 — SkillRequirementCondition
typeenum
Required
equal
skillstring· min length 1
Required
valuestring
Required
Option 2 — SkillRequirementGroup
typeenum
Required
and
or
entriesone of[]· min items 1
Required
Option 1 — SkillRequirementCondition
typeenum
Required
equal
skillstring· min length 1
Required
valuestring
Required
Option 2 — SkillRequirementNestedGroup
typeenum
Required
and
or
entriesSkillRequirementCondition[]· min items 1
Required
typeenum
Required
skillstring· min length 1
Required
valuestring
Required
preferencesobject

Soft filters for possible slots

Show properties
providerIdsstring[]
skillSkillRequirement
Option 1 — SkillRequirementCondition
typeenum
Required
equal
skillstring· min length 1
Required
valuestring
Required
Option 2 — SkillRequirementGroup
typeenum
Required
and
or
entriesone of[]· min items 1
Required
Option 1 — SkillRequirementCondition
typeenum
Required
equal
skillstring· min length 1
Required
valuestring
Required
Option 2 — SkillRequirementNestedGroup
typeenum
Required
and
or
entriesSkillRequirementCondition[]· min items 1
Required
typeenum
Required
skillstring· min length 1
Required
valuestring
Required
limitnumber· default 10

Maximum number of slots to return

Response 201#

resultsAppointmentSlot[]
Required
scorenumber
Required

Arbitrary number for ranking slots relative to each other. Should not be compared to anything besides the appointments returned by this request.

appointmentTypeIdstring
Required
startDatestring
Required
endDatestring
Required
providerIdstring
Required

Errors#

validation400

Input validation failed.

Show extension members
pathstring
messagestring
Required
appointment-type-not-found404

A specified appointmenttype does not exist in the system.