Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-06130577659.7 KB
Documents|Form definition

Fetch form definition list.

This endpoint enables you to retrieve form definitions. This includes the document name, version, creation date, and last update date. Additionally, you can set an offset and a limit. The default limit and maximum limit are both set at 100.

get/custom_form_definition/fetch

Query parameters

filter[byIds][]integer[]

Filters the form definition based on the internal IDs.

filter[byText]string

Filters the form definition based on the text passed.

filter[byExternalReference]string

Filters the form definition based on the external reference.

offsetinteger

Use this parameter to specify the number of records you want to skip before starting to collect the data from the result set.

limitinteger

The limit parameter defines the maximum number of records that can be retrieved in a single API request, with a max and default value set at 500 records.

Response

Success Response:

offsetinteger

Use this parameter to specify the number of records you want to skip before starting to collect the data from the result set.

totalCountinteger

Total number of available form definitions. (Only calculated if offset is 0)

Example response

{
  "data": [
    {
      "createdAt": "2015-02-20T12:59:21+01:00",
      "updatedAt": "2015-02-20T12:59:21+01:00"
    }
  ]
}