Sign in
Forms

Get a form by ID

Gets a form by its ID.

get/api/forms/{formId}

Path parameters

formIdinteger required

The ID of the form.

Response

Form retrieved successfully.

idstring nullable

The ID of the form.

namestring nullable

The name of the form.

descriptionstring nullable

The description of the form.

isEnabledboolean

Indicates if the form is enabled.

themeIdstring nullable

The ID of the theme associated with the form.

createdAtstring date-time

The date and time when the form was created.

modifiedAtstring date-time nullable

The date and time when the form was last modified.

submissionsCountinteger nullable

The total number of submissions for the form

webHookSettingsJsonstring nullable

The JSON data containing webhook configuration settings for this form as a string.

{"stackTrail":"components:schemas:FormModel:properties:webHookSettings","oasType":"schema","type":"unknown","description":"The webhook configuration settings as a JSON object.","nullable":true}

Changes

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

  • 50eff5014b7813See 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 themeId to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property webHookSettingsJson 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 themeId from the response with the 200 status

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

      removed the optional property webHookSettingsJson 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