Get a form
Retrieve the published fields, editable drafts, version, and current form state.
GET
/api/v1/forms/{formId}Authorization
Authorization required string · header
Bearer <token> with an account API key that has the forms:read scope. Path parameters
formId required string
Response
200 · application/json
Source model: FormModel.
| Field | Type | Description |
|---|---|---|
id | string | ID returned by the operation. |
name | string | Display name. |
workspaceId | string | Workspace ID. |
projectId | string | Project ID. |
fields | array | Published questions and endings. See FormField. |
drafts | array | Sanitized editable questions and endings. See FormField. |
hiddenFields | array | Hidden fields. See HiddenField. |
variables | array | Variables associated with the resource. See Variable. |
logics | array | Published branching rules. See Logic. |
draftLogics | array | Editable branching rules, when present. See Logic. |
themeSettings | object | Theme, logo, and favicon settings, when present. See ThemeSettings. |
status | integer | 1 for a normal form and 2 for a form in the trash. See FormStatusEnum. |
active | boolean | Whether the form accepts responses. |
version | integer | Current draft version. |
publishedAt | integer | Time of first publication as Unix seconds. 0 means the form has never been published. |