Get scheduler by ID

Request

Retrieve a scheduler (scheduler config) and its weekly template (days, hours, slot quantity, and the practitioner / appointment-type IDs bound to each day).

Security

PartnerApiKey and PartnerOAuth

Path

schedulerConfigIdinteger, (int64)required

Scheduler config ID

Example:1312

accountIdinteger, (int64)required

Account identifier

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

Responses

Scheduler retrieved successfully

Bodyapplication/json

activeboolean

Whether the scheduler is active

Example:true

idinteger, (int64)

Scheduler config ID (the integer in the settings URL)

Example:1312

locationIdinteger, (int64)

Location ID this scheduler belongs to

Example:1312

namestring

Scheduler name

Example:"Plano Lab Review / Med Reorder"

templatesArray of objects(SchedulerTemplateDTO)

Weekly template (recurring availability), ordered Monday-first. Always returned by the single-scheduler GET; in list responses only when includeTemplates=true, and null otherwise. A scheduler with no template returns an empty array, so null means "not requested" rather than "none configured".

Response

{
  "active": true,
  "id": 1312,
  "locationId": 1312,
  "name": "Plano Lab Review / Med Reorder",
  "templates": [
    { … }
  ]
}