Forms
Get a form
Getting started
Users
Form submissions
Workspaces
Forms
Get a form
Returns a single form by its ID with all its blocks and settings.
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the form to retrieve
Response
200
application/json
Form retrieved successfully
Available options:
BLANK, DRAFT, PUBLISHED, DELETED Maximum length:
12Maximum length:
256Maximum length:
12Maximum length:
12Required range:
x > 0Required range:
x > 0Maximum length:
12Available options:
FORM_TITLE, TEXT, LABEL, TITLE, HEADING_1, HEADING_2, HEADING_3, DIVIDER, PAGE_BREAK, THANK_YOU_PAGE, IMAGE, EMBED, EMBED_VIDEO, EMBED_AUDIO, QUESTION, MULTIPLE_CHOICE, CHECKBOXES, DROPDOWN, RANKING, MATRIX, MULTI_SELECT, INPUT_TEXT, INPUT_NUMBER, INPUT_EMAIL, INPUT_LINK, INPUT_PHONE_NUMBER, INPUT_DATE, INPUT_TIME, TEXTAREA, FILE_UPLOAD, LINEAR_SCALE, RATING, HIDDEN_FIELDS, MULTIPLE_CHOICE_OPTION, CHECKBOX, DROPDOWN_OPTION, RANKING_OPTION, MULTI_SELECT_OPTION, PAYMENT, SIGNATURE, MATRIX_ROW, MATRIX_COLUMN, WALLET_CONNECT, CONDITIONAL_LOGIC, CALCULATED_FIELDS, CAPTCHA, RESPONDENT_COUNTRY Available options:
FORM_TITLE, TEXT, LABEL, TITLE, HEADING_1, HEADING_2, HEADING_3, DIVIDER, PAGE_BREAK, THANK_YOU_PAGE, IMAGE, EMBED, EMBED_VIDEO, EMBED_AUDIO, QUESTION, MULTIPLE_CHOICE, CHECKBOXES, DROPDOWN, RANKING, MATRIX, MULTI_SELECT, INPUT_TEXT, INPUT_NUMBER, INPUT_EMAIL, INPUT_LINK, INPUT_PHONE_NUMBER, INPUT_DATE, INPUT_TIME, TEXTAREA, FILE_UPLOAD, LINEAR_SCALE, RATING, HIDDEN_FIELDS, MULTIPLE_CHOICE_OPTION, CHECKBOX, DROPDOWN_OPTION, RANKING_OPTION, MULTI_SELECT_OPTION, PAYMENT, SIGNATURE, MATRIX_ROW, MATRIX_COLUMN, WALLET_CONNECT, CONDITIONAL_LOGIC, CALCULATED_FIELDS, CAPTCHA, RESPONDENT_COUNTRY 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": {}
}
]
}