Forms

List form definitions

Lists form definitions for a given form as a paged envelope (items, page, pageSize, totalRecords, totalPages). Optional sort and created/modified date bounds. Empty form returns 404.

get/api/forms/{formId}/definitions

Path parameters

formIdinteger required

The ID of the form.

Query parameters

pageinteger nullable

The page number (1-based).

pageSizeinteger nullable

The number of items per page.

sortBystring nullable

Sort field (createdAt, modifiedAt).

sortDirstring nullable

Sort direction (asc, desc).

createdFromstring nullable

Inclusive UTC calendar day (YYYY-MM-DD) for createdAt.

createdTostring nullable

Inclusive UTC calendar day (YYYY-MM-DD) for createdAt.

modifiedFromstring nullable

Inclusive UTC calendar day (YYYY-MM-DD) for modifiedAt.

modifiedTostring nullable

Inclusive UTC calendar day (YYYY-MM-DD) for modifiedAt.

Response

Form definitions retrieved successfully.

pageinteger

pageSizeinteger

totalRecordsinteger

totalPagesinteger

Changes

Changed in 3 of the 7 revisions of this API.2315

Aug 27, 202601bd299fd100111See the full diff
- ▲
  the response's body type/format changed from array/ to object/ for status 200
  response-body-type-changed
- ○
  added the new optional query request parameter createdFrom
  new-optional-request-parameter
- ○
  added the new optional query request parameter createdTo
  new-optional-request-parameter
- ○
  added the new optional query request parameter modifiedFrom
  new-optional-request-parameter
- ○
  added the new optional query request parameter modifiedTo
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortBy
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortDir
  new-optional-request-parameter
- ○
  added the optional property items to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property page to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property pageSize to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property totalPages to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property totalRecords to the response with the 200 status
  response-optional-property-added
Nov 21, 202550eff5014b7813See the full diff
- ▲
  removed the media type application/problem+json for the response with the status 400
  response-media-type-removed
- ○
  added the optional property items/customQuestions to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/requiresReCaptcha to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/themeModel to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 24, 2025fbc3fe6ecbf131See the full diff
- ●
  removed the optional property items/customQuestions from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/requiresReCaptcha from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/themeModel from the response with the 200 status
  response-optional-property-removed
- ○
  added the media type application/problem+json for the response with the status 400
  response-media-type-added
This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history