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

get/forms/{formId}

Request

  • Base URL
    https://api.tally.so
  • URL
    https://api.tally.so/forms/{formId}
  • Auth
    HTTP bearer

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"
          ]
        }
      }
    }
  ]
}

Changes

    • breaking

      the // response property's maxLength was unset from 12 for the response status

    • warning

      added the new af enum value to the // response property for the response status

    • warning

      added the new ar enum value to the // response property for the response status

    • warning

      added the new bg enum value to the // response property for the response status

    • warning

      added the new bn enum value to the // response property for the response status

    • warning

      added the new ca enum value to the // response property for the response status

    • warning

      added the new cs enum value to the // response property for the response status

    • warning

      added the new da enum value to the // response property for the response status

    • warning

      added the new de enum value to the // response property for the response status

    • warning

      added the new el enum value to the // response property for the response status

    • warning

      added the new en enum value to the // response property for the response status

    • warning

      added the new es enum value to the // response property for the response status

    • warning

      added the new es-MX enum value to the // response property for the response status

    • warning

      added the new et enum value to the // response property for the response status

    • warning

      added the new eu enum value to the // response property for the response status

    • warning

      added the new fa enum value to the // response property for the response status

    • warning

      added the new fi enum value to the // response property for the response status

    • warning

      added the new fil enum value to the // response property for the response status

    • warning

      added the new fo enum value to the // response property for the response status

    • warning

      added the new fr enum value to the // response property for the response status

    • warning

      added the new ga enum value to the // response property for the response status

    • warning

      added the new he enum value to the // response property for the response status

    • warning

      added the new hi enum value to the // response property for the response status

    • warning

      added the new hr enum value to the // response property for the response status

    • warning

      added the new hu enum value to the // response property for the response status

    • warning

      added the new id enum value to the // response property for the response status

    • warning

      added the new is enum value to the // response property for the response status

    • warning

      added the new it enum value to the // response property for the response status

    • warning

      added the new ja enum value to the // response property for the response status

    • warning

      added the new ka enum value to the // response property for the response status

    • warning

      added the new kl enum value to the // response property for the response status

    • warning

      added the new ko enum value to the // response property for the response status

    • warning

      added the new lt enum value to the // response property for the response status

    • warning

      added the new lv enum value to the // response property for the response status

    • warning

      added the new mk enum value to the // response property for the response status

    • warning

      added the new ms enum value to the // response property for the response status

    • warning

      added the new nl enum value to the // response property for the response status

    • warning

      added the new no enum value to the // response property for the response status

    • warning

      added the new pl enum value to the // response property for the response status

    • warning

      added the new pt enum value to the // response property for the response status

    • warning

      added the new pt-BR enum value to the // response property for the response status

    • warning

      added the new ro enum value to the // response property for the response status

    • warning

      added the new ru enum value to the // response property for the response status

    • warning

      added the new si enum value to the // response property for the response status

    • warning

      added the new sk enum value to the // response property for the response status

    • warning

      added the new sl enum value to the // response property for the response status

    • warning

      added the new sq enum value to the // response property for the response status

    • warning

      added the new sr enum value to the // response property for the response status

    • warning

      added the new sv enum value to the // response property for the response status

    • warning

      added the new ta enum value to the // response property for the response status

    • warning

      added the new th enum value to the // response property for the response status

    • warning

      added the new tr enum value to the // response property for the response status

    • warning

      added the new uk enum value to the // response property for the response status

    • warning

      added the new undefined enum value to the // response property for the response status

    • warning

      added the new uz enum value to the // response property for the response status

    • warning

      added the new vi enum value to the // response property for the response status

    • warning

      added the new yo enum value to the // response property for the response status

    • warning

      added the new zh-CN enum value to the // response property for the response status

    • warning

      added the new zh-TW enum value to the // response property for the response status

    • breaking

      the response property //////////// became optional for the status