Skip to content

List appointment types

Request

Retrieve a paginated list of active appointment types for the account. Supports filtering by name/description and keyset pagination.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
namestring, [ 0 .. 100 ] characters

Filter appointment types by name (case-insensitive contains match)

Example:name=Consultation
descriptionstring, [ 0 .. 500 ] characters

Filter appointment types by description (case-insensitive contains match)

Example:description=arrive 15 minutes early
sortBystring(?i)NAME|CREATED_DATE|DURATION

Sort by field

Default:"NAME"
Enum:"NAME""CREATED_DATE""DURATION"
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
activeboolean

Filter by active status. If not specified, returns both active and inactive appointment types.

Enum:truefalse
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/appointment/type?name=Consultation&description=arrive%2015%20minutes%20early&sortBy=NAME&sortDir=ASC&cursor=string&limit=20&active=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Appointment types retrieved successfully

Bodyapplication/json
appointmentTypesArray of objects(AppointmentTypeDTO)

List of appointment types in this page

nextCursorstring

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

Example:"eyJpZCI6MTAwMSwibmFtZSI6IkNvbnN1bHQifQ"
Response
{
  "appointmentTypes": [
    { … }
  ],
  "nextCursor": "eyJpZCI6MTAwMSwibmFtZSI6IkNvbnN1bHQifQ"
}