Self-Scheduling

Get appointment availability

Request

Returns available appointment slots for a time range. Time range must not exceed 2 months (62 days).

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

Query

selfSchedulingSettingIdinteger, (int64)required

Self-scheduling setting ID

Example:selfSchedulingSettingId=123

startUnixinteger, (int64)required

Start time in milliseconds since epoch

Example:startUnix=1704067200000

endUnixinteger, (int64)required

End time in milliseconds since epoch

Example:endUnix=1706745600000

locationIdinteger, (int64)required

Location ID

Example:locationId=1

appointmentTypeIdinteger, (int64)required

Appointment type ID

Example:appointmentTypeId=10

practitionerIdsstring

Comma-separated practitioner IDs to filter (optional)

Example:practitionerIds=7,8,9

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/self-scheduling/availability?selfSchedulingSettingId=123&startUnix=1704067200000&endUnix=1706745600000&locationId=1&appointmentTypeId=10&practitionerIds=7%2C8%2C9' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Availability slots retrieved successfully

Bodyapplication/json

arePractitionersSelectableboolean

If true, the patient can choose their practitioner and each slot includes a practitionerToConfig map. If false, the system auto-assigns the best-ranked practitioner and each slot includes a single practitionerId.

Example:true

practitionersArray of objects(PractitionerOutputDTO)

List of practitioners who have availability in the queried time range

slotsByDateobject

Available time slots grouped by date. Keys are dates in M/d/yyyy format (e.g. "1/15/2025"). Values are arrays of available slots for that date, sorted by time then practitioner rank. Only dates with available slots are included.

timeZonestring

IANA timezone of the practice location (all slot times are in UTC epoch millis)

Example:"America/New_York"

Response

Non-selectable practitioners