Skip to content

Get form by ID

Request

Returns the complete structure of a single form identified by its _id.

The response includes everything needed to understand or reproduce the form:

  • questions — ordered list of all questions, each with its type (questionType), label, description, required flag, and type-specific settings (choice options, text constraints, file upload limits, etc.).
  • baseSettings — behavioural settings: captcha, draft saving, multi-step navigation, multiple-submission prevention, and more.
  • designSettings — visual theme: colours (background, question, answer, border, main), font family and size, border radius, background image, and theme name.
  • logo — logo image URL, alignment, brightness, and sticky behaviour.
  • thankYouPages — one or more thank-you screens shown after submission, including redirect configuration, sharing options, and statistics display.
  • submitButton — label text and alignment of the submission button.
  • state — visibility of the form: public, unlisted, or private.
  • supportedLanguages — language codes the form is available in.
  • calculators / conditions — scoring calculator rules and conditional logic (raw arrays).
  • createDate / updateDate — ISO 8601 timestamps of creation and last modification.

Returns 404 Not Found if the form does not exist or belongs to a different account.

Security
BearerAuth or ApiKeyAuth
Path
idstringrequired

The unique identifier (_id) of the form to retrieve.

curl -i -X GET \
  'https://developers.forms.app/_mock/apis/v1/form/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Form returned successfully.

Bodyapplication/json
successboolean

Always true for successful responses.

Value:true
dataobject(Form)

The response payload. Shape depends on the endpoint.

errorsArray of any, <= 0 items

Always an empty array on success.

Response
{ "success": true, "data": { "_id": "string", "baseSettings": { … }, "calculators": [ … ], "conditions": [ … ], "createDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z", "creatorId": "string", "currencySymbolLocation": "before", "designSettings": { … }, "isArchived": true, "isTrash": true, "isUsedCalculator": true, "isUserInaccessible": true, "logo": { … }, "questions": [ … ], "state": "public", "submitButton": { … }, "supportedLanguages": [ … ], "thankYouPages": [ … ], "title": "string", "version": 0, "afterSubmissionSettings": { … }, "calculatorSettings": { … }, "conversionCodes": { … }, "cover": { … }, "defaultLanguage": "string", "directMessageSettings": { … }, "enableCustomMessage": true, "folderIds": [ … ], "googleMapApiKey": "string", "importedFormId": "string", "importedUserId": "string", "isEnabledWhenDowngrade": true, "isImportUncomplated": true, "isStarred": true, "isSuspended": true, "isSuspendedWhenDowngrade": true, "lastEdited": { … }, "locationSettings": { … }, "metaData": { … }, "pageSettings": { … }, "publishDateSettings": { … }, "unpublishDateSettings": { … }, "reportState": "string", "thankYouPageSettings": { … }, "timer": { … }, "trashDate": "2019-08-24T14:15:22Z", "userInfo": {}, "userLabelSetId": "string", "welcomePageSettings": { … }, "withAI": true }, "errors": [] }