Skip to content

Get self-scheduling setting

Request

Retrieve self-scheduling configuration with associated practitioners, locations, appointment types, and scheduler configs.

Security
PartnerApiKey and PartnerOAuth
Path
selfSchedulingSettingIdinteger, (int64)required

Self-scheduling setting ID

Example:123
accountIdinteger, (int64)required

Account identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/self-scheduling/setting/123' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Self-scheduling setting retrieved successfully

Bodyapplication/json
activeboolean

Whether the scheduler is active

Example:true
afterwardBookingLimitinteger, (int32)

Afterward booking limit value (minimum time before appointment)

afterwardBookingLimitActiveboolean

Whether afterward booking limit is active

Example:false
afterwardBookingLimitUnitstring

Unit for afterward booking limit

Enum:"HOURS""DAYS""WEEKS""MONTHS"
Example:"null"
appointmentTypeIdsArray of integers

List of associated appointment type IDs

appointmentTypeSelectableboolean

Whether patients can select the appointment type

Example:true
appointmentTypeVisibleboolean

Whether appointment type selection is visible to patients

Example:true
fixedAppointmentTypeIdinteger, (int64)

Fixed appointment type ID if not selectable

fixedLocationIdinteger, (int64)

Fixed location ID if location is not selectable

forwardBookingLimitinteger, (int32)

Forward booking limit value

Example:30
forwardBookingLimitActiveboolean

Whether forward booking limit is active

Example:true
forwardBookingLimitUnitstring

Unit for forward booking limit

Enum:"HOURS""DAYS""WEEKS""MONTHS"
Example:"DAYS"
idinteger, (int64)

Self-scheduling setting ID

Example:123
locationIdsArray of integers

List of associated location IDs

locationSelectableboolean

Whether patients can select the location

Example:true
locationVisibleboolean

Whether location selection is visible to patients

Example:true
namestring

Display name for this scheduler

Example:"New Patient Appointments"
practitionerIdsArray of integers

List of associated practitioner IDs

practitionerSelectableboolean

Whether patients can select their practitioner

Example:true
practitionerVisibleboolean

Whether practitioner selection is visible to patients

Example:true
publicUuidstring

Public UUID for this setting

Example:"550e8400-e29b-41d4-a716-446655440000"
schedulerConfigIdsArray of integers

List of scheduler config IDs for booking appointments

verificationMethodstring

Method used to verify patient identity

Enum:"EMAIL""SMS""EMAIL_AND_SMS"
Example:"EMAIL_AND_SMS"
welcomeMessageSubtitlestring

Welcome message subtitle

Example:"Please select a time for your appointment"
welcomeMessageTitlestring

Welcome message title

Example:"Welcome to Our Practice"
Response
{
  "active": true,
  "afterwardBookingLimit": 0,
  "afterwardBookingLimitActive": false,
  "afterwardBookingLimitUnit": "null",
  "appointmentTypeIds": [
    0
  ],
  "appointmentTypeSelectable": true,
  "appointmentTypeVisible": true,
  "fixedAppointmentTypeId": 0,
  "fixedLocationId": 0,
  "forwardBookingLimit": 30,
  "forwardBookingLimitActive": true,
  "forwardBookingLimitUnit": "DAYS",
  "id": 123,
  "locationIds": [
    0
  ],
  "locationSelectable": true,
  "locationVisible": true,
  "name": "New Patient Appointments",
  "practitionerIds": [
    0
  ],
  "practitionerSelectable": true,
  "practitionerVisible": true,
  "publicUuid": "550e8400-e29b-41d4-a716-446655440000",
  "schedulerConfigIds": [
    0
  ],
  "verificationMethod": "EMAIL_AND_SMS",
  "welcomeMessageSubtitle": "Please select a time for your appointment",
  "welcomeMessageTitle": "Welcome to Our Practice"
}