List self-scheduling settings

Request

Retrieve the account's self-scheduling settings. Provide the optional publicUuid filter to resolve the setting behind a patient booking link (the UUID embedded in booking URLs) to its numeric id; the mapping can then be cached and used to call the availability endpoint.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

Query

publicUuidstring, [ 0 .. 255 ] characters

Public booking-link UUID to resolve to a single setting. When supplied, returns only the matching setting; a UUID that does not exist or belongs to another account returns 404.

Example:publicUuid=e33a52cb-1a33-4cb7-9d91-7a0238da5c0b

sortDirstring(?i)ASC|DESC

Sort direction (by setting id)

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}/self-scheduling/setting?publicUuid=e33a52cb-1a33-4cb7-9d91-7a0238da5c0b&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Self-scheduling settings retrieved successfully

Bodyapplication/json

nextCursorstring

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

Example:"null"

settingsArray of objects(SelfSchedulingSettingResponse)

List of self-scheduling settings

Response

{
  "nextCursor": "null",
  "settings": [
    { … }
  ]
}