GET
/
forms
/
{id}
curl --request GET \
  --url https://api.tally.so/forms/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "workspaceId": "<string>",
  "status": "BLANK",
  "numberOfSubmissions": 123,
  "isClosed": true,
  "payments": [
    {
      "amount": 123,
      "currency": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "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": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the form to retrieve

Response

200
application/json

Form retrieved successfully

The response is of type object.