Skip to main content
GET
/
forms
/
{formId}
Retrieve a form
curl --request GET \
  --url https://api.tally.so/forms/{formId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "status": "BLANK",
  "numberOfSubmissions": 123,
  "isClosed": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "payments": [
    {
      "amount": 123,
      "currency": "<string>"
    }
  ],
  "settings": {
    "language": "<string>",
    "isClosed": false,
    "closeMessageTitle": "<string>",
    "closeMessageDescription": "<string>",
    "closeTimezone": "<string>",
    "closeDate": "<string>",
    "closeTime": "<string>",
    "submissionsLimit": 1,
    "uniqueSubmissionKey": "<string>",
    "redirectOnCompletion": "<string>",
    "hasSelfEmailNotifications": false,
    "selfEmailTo": "<string>",
    "selfEmailReplyTo": "<string>",
    "selfEmailSubject": "<string>",
    "selfEmailFromName": "<string>",
    "selfEmailBody": "<string>",
    "hasRespondentEmailNotifications": false,
    "respondentEmailTo": "<string>",
    "respondentEmailReplyTo": "<string>",
    "respondentEmailSubject": "<string>",
    "respondentEmailFromName": "<string>",
    "respondentEmailBody": "<string>",
    "hasProgressBar": false,
    "hasPartialSubmissions": false,
    "pageAutoJump": false,
    "saveForLater": true,
    "styles": "<string>",
    "password": "<string>",
    "submissionsDataRetentionDuration": 1,
    "submissionsDataRetentionUnit": "<string>"
  },
  "blocks": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "FORM_TITLE",
      "groupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupType": "FORM_TITLE",
      "payload": {
        "html": "<string>",
        "logo": "<string>",
        "cover": "<string>",
        "coverSettings": {
          "objectPositionYPercent": 50
        },
        "mentions": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "field": {
              "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "InputField",
              "questionType": "INPUT_TEXT",
              "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "title": "<string>",
              "calculatedFieldType": "NUMBER"
            },
            "defaultValue": "<unknown>"
          }
        ],
        "button": {
          "label": "<string>"
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
formId
string
required

The ID of the form to retrieve

Response

Form retrieved successfully

​
id
string
required
​
name
string
required
​
workspaceId
string
required
​
status
enum<string>
required
Available options:
BLANK,
DRAFT,
PUBLISHED,
DELETED
​
numberOfSubmissions
number
required
​
isClosed
boolean
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
payments
object[]
​
settings
object
​
blocks
(FormTitleBlock · object | TitleBlock · object | QuestionBlock · object | TextBlock · object | LabelBlock · object | Heading1Block · object | Heading2Block · object | Heading3Block · object | ImageBlock · object | EmbedBlock · object | EmbedVideoBlock · object | EmbedAudioBlock · object | DividerBlock · object | PageBreakBlock · object | InputTextBlock · object | TextareaBlock · object | InputNumberBlock · object | InputEmailBlock · object | InputLinkBlock · object | InputPhoneNumberBlock · object | InputDateBlock · object | InputTimeBlock · object | MultipleChoiceBlock · object | MultipleChoiceOptionBlock · object | CheckboxesBlock · object | CheckboxBlock · object | DropdownBlock · object | DropdownOptionBlock · object | RankingOptionBlock · object | MultiSelectBlock · object | MultiSelectOptionBlock · object | LinearScaleBlock · object | RatingBlock · object | MatrixBlock · object | MatrixRowBlock · object | MatrixColumnBlock · object | FileUploadBlock · object | SignatureBlock · object | PaymentBlock · object | WalletConnectBlock · object | HiddenFieldsBlock · object | ConditionalLogicBlock · object | CalculatedFieldsBlock · object | CaptchaBlock · object | RespondentCountryBlock · object)[]

A block with type FORM_TITLE. Used for the main form title with optional logo and cover image.