Skip to content

List form templates

Request

Retrieve a paginated list of form templates for the account. Templates define the structure of forms that can be assigned to patients. Supports filtering by appointment type and staff-only visibility.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
appointmentTypeIdinteger, (int64)

Filter by appointment type ID

isStaffOnlyboolean

Filter for staff-only templates

activeboolean

Filter by active status

Enum:truefalse
searchstring

Search by template name

cursorstring

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}/location/{locationId}/form/template?appointmentTypeId=0&isStaffOnly=true&active=true&search=string&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Form templates retrieved successfully

Bodyapplication/json
formTemplatesArray of objects(FormTemplateListItemDTO)

List of form templates in this page

nextCursorstring

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

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