Skip to content

Get form template by ID

Request

Retrieve detailed information about a form template including all form elements/fields. Use this to understand the structure of a form for integration purposes.

Security
PartnerApiKey and PartnerOAuth
Path
formTemplateIdinteger, (int64)required

Form template ID

Example:12345
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
includeElementsboolean

Include form elements/fields in response

Default:true
Example:includeElements=true
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/form/template/12345?includeElements=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Form template found and returned successfully

Bodyapplication/json
appointmentTypeIdsArray of integers

Associated appointment type IDs

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
elementCountinteger, (int32)

Total number of form elements including nested child elements

Example:15
elementsArray of objects(FormElementDTO)

Form elements/fields (if requested)

idinteger, (int64)

Unique form template identifier

Example:12345
isActiveboolean

Whether this template is active

Example:true
isDirectlyLinkableboolean

Whether this template can be directly linked (public form)

Example:true
isFillablePdfboolean

Whether this template is a fillable PDF

Example:false
isStaffOnlyboolean

Whether this template is staff-only (not visible to patients)

Example:false
namestring

Template name

Example:"Patient Intake Form"
updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
Response
{
  "appointmentTypeIds": [
    0
  ],
  "createdAt": "2025-01-15T14:00:00Z",
  "elementCount": 15,
  "elements": [
    { … }
  ],
  "id": 12345,
  "isActive": true,
  "isDirectlyLinkable": true,
  "isFillablePdf": false,
  "isStaffOnly": false,
  "name": "Patient Intake Form",
  "publicLink": "https://forms.lobbie.com/t/abc123",
  "updatedAt": "2025-01-15T14:00:00Z"
}