Skip to content

List form template groups

Request

Retrieve a list of form template groups for the account. Form template groups are pre-configured collections of forms that can be assigned together.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
practitionerIdinteger, (int64)

Filter by practitioner ID

activeboolean

Filter by active status

Enum:truefalse
cursorstring

Pagination cursor

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

Responses

Form template groups retrieved successfully

Bodyapplication/json
groupsArray of objects(FormTemplateGroupDTO)

List of form template groups in this page

nextCursorstring

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

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