Skip to main content
POST
/
v1
/
appointments
/
slots
Search Appointment Slots
curl --request POST \
  --url https://app.untetherlabs.com/api/v1/appointments/slots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appointmentTypeId": "<string>",
  "startDate": "2024-11-20T07:43:34+0000",
  "endDate": "2024-11-20T07:43:34+0000",
  "requirements": {
    "providerIds": [
      "<string>"
    ],
    "skill": {
      "type": "equal",
      "skill": "<string>",
      "value": "<string>"
    }
  },
  "preferences": {
    "providerIds": [
      "<string>"
    ],
    "skill": {
      "type": "equal",
      "skill": "<string>",
      "value": "<string>"
    }
  },
  "limit": 10
}
'
{
  "results": [
    {
      "score": 123,
      "appointmentTypeId": "<string>",
      "startDate": "2024-11-20T07:43:34+0000",
      "endDate": "2024-11-20T07:43:34+0000",
      "providerId": "<string>"
    }
  ]
}
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.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
appointmentTypeId
string
required
startDate
string
required
Example:

"2024-11-20T07:43:34+0000"

endDate
string
required
Example:

"2024-11-20T07:43:34+0000"

requirements
object

Hard filters for possible slots

preferences
object

Soft filters for possible slots

limit
number
default:10

Maximum number of slots to return

Response

results
object[]
required