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