Sign in
Forms

List forms

Lists all forms with optional pagination.

get/api/forms

Query parameters

pageinteger nullable

The number of the page

pageSizeinteger nullable

The number of items to take.

filterstring[] nullable

The filter expressions

Response

Forms 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.145

  • 50eff5014b7814See the full diff
    • ▲

      removed the media type application/problem+json for the response with the status 400

      response-media-type-removed

    • ○

      added the new optional query request parameter filter

      new-optional-request-parameter

    • ○

      added the optional property items/themeId to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

  • fbc3fe6ecbf141See the full diff
    • ●

      deleted the query request parameter filter

      request-parameter-removed

    • ●

      removed the optional property items/themeId from the response with the 200 status

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

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