Skip to main content
GET
/
forms
/
{formId}
Retrieve a form
curl --request GET \
  --url https://api.tally.so/forms/{formId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.tally.so/forms/{formId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tally.so/forms/{formId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tally.so/forms/{formId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tally.so/forms/{formId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.tally.so/forms/{formId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.tally.so/forms/{formId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "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": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "redirectOnCompletion": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "hasSelfEmailNotifications": false,
    "selfEmailTo": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "selfEmailReplyTo": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "selfEmailSubject": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "selfEmailFromName": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "selfEmailBody": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "hasRespondentEmailNotifications": false,
    "respondentEmailTo": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "respondentEmailReplyTo": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "respondentEmailSubject": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "respondentEmailFromName": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "respondentEmailBody": {
      "html": "<string>",
      "mentions": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "field": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "<string>",
            "payload": {}
          },
          "defaultValue": "<unknown>"
        }
      ]
    },
    "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",
      "payload": {
        "html": "<string>",
        "title": "<string>",
        "logo": "<string>",
        "cover": "<string>",
        "coverSettings": {
          "objectPositionYPercent": 50
        },
        "mentions": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "field": {
              "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "blockGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "title": "<string>",
              "payload": {}
            },
            "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 | 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 | MultipleChoiceOptionBlock · object | CheckboxBlock · object | DropdownOptionBlock · object | RankingOptionBlock · object | MultiSelectOptionBlock · object | LinearScaleBlock · object | RatingBlock · object | MatrixBlock · object | MatrixRowBlock · object | MatrixColumnBlock · object | FileUploadBlock · object | SignatureBlock · object | PaymentBlock · 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.