Skip to content

List schedulers

Request

Retrieve the account's schedulers (scheduler configs), optionally filtered by location and active status. Use the returned id to resolve a schedule for appointment creation. Weekly templates are omitted by default; pass includeTemplates=true to return them inline instead of fetching each scheduler individually.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
locationIdinteger, (int64)

Filter by location ID

activeboolean

Filter by active status

includeTemplatesboolean

Include each scheduler's weekly template in the response

Default:false
Example:includeTemplates=false
sortBystring(?i)NAME|CREATED_DATE

Sort by field

Default:"NAME"
Enum:"NAME""CREATED_DATE"
sortDirstring(?i)ASC|DESC

Sort direction

Default:"ASC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/scheduler?locationId=0&active=true&includeTemplates=false&sortBy=NAME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Schedulers retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

schedulersArray of objects(SchedulerDTO)

List of schedulers in this page

Response
{
  "nextCursor": "string",
  "schedulers": [
    { … }
  ]
}