Get a form

Retrieve the published fields, editable drafts, version, and current form state.


GET/api/v1/forms/{formId}

Authorization

Authorization required string · header
Send Bearer <token> with an account API key that has the forms:read scope.

Path parameters

formId required string
Form ID. See FormModel.

Response

200 · application/json

Source model: FormModel.

FieldTypeDescription
idstringID returned by the operation.
namestringDisplay name.
workspaceIdstringWorkspace ID.
projectIdstringProject ID.
fieldsarrayPublished questions and endings. See FormField.
draftsarraySanitized editable questions and endings. See FormField.
hiddenFieldsarrayHidden fields. See HiddenField.
variablesarrayVariables associated with the resource. See Variable.
logicsarrayPublished branching rules. See Logic.
draftLogicsarrayEditable branching rules, when present. See Logic.
themeSettingsobjectTheme, logo, and favicon settings, when present. See ThemeSettings.
statusinteger1 for a normal form and 2 for a form in the trash. See FormStatusEnum.
activebooleanWhether the form accepts responses.
versionintegerCurrent draft version.
publishedAtintegerTime of first publication as Unix seconds. 0 means the form has never been published.