v3

latestOpenAPI 3.0.1MIT2026-08-0438140196.2 KB

Retrieve a form

Returns a single form by its ID with all its blocks and settings.

get/forms/{formId}

Path parameters

formIdstring required

The ID of the form to retrieve

Response

Form retrieved successfully

idstring required

namestring required

workspaceIdstring required

status'BLANK' | 'DRAFT' | 'PUBLISHED' required

Deleting a form is done through DELETE /forms/{formId}, which moves it to the trash so it can be restored.

numberOfSubmissionsnumber required

isClosedboolean required

createdAtstring date-time required

updatedAtstring date-time required

Example response

{
  "blocks": [
    {
      "payload": {
        "allowedFiles": {
          "image/*": [
            ".png",
            ".jpg",
            ".gif"
          ],
          "application/*": [
            ".pdf"
          ]
        }
      }
    }
  ]
}