Sign in
Forms

Get the active form definition

Gets the active form definition for a given form.

get/api/forms/{formId}/definition

Path parameters

formIdinteger required

The ID of the form.

Response

Active form definition retrieved successfully.

idstring nullable

The ID of the form definition.

isDraftboolean

Indicates if the form definition is a draft.

jsonDatastring nullable

The JSON data of the form definition.

formIdstring nullable

The ID of the associated form.

createdAtstring date-time

The date and time when the form definition was created.

modifiedAtstring date-time nullable

The date and time when the form definition was last modified.

themeModelstring nullable

The model of the associated theme stored as a stringified JSON object.

customQuestionsstring[] nullable

The list of custom questions' JSON data associated with this form definition.

requiresReCaptchaboolean nullable

Indicates if reCAPTCHA is enabled for this form definition.

Changes

Changed in 2 of the 7 revisions of this API.35

  • 50eff5014b784See the full diff
    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      added the optional property customQuestions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property requiresReCaptcha to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property 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

  • fbc3fe6ecbf131See the full diff
    • ●

      removed the optional property customQuestions from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property requiresReCaptcha from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property themeModel from the response with the 200 status

      response-optional-property-removed

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    This revision also has 62 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog