FormsForms

Get Form Schema

Get information about a given form.

Required scope | forms:read

Path parameters

form_idstringRequiredformat: "objectid"
Unique identifier for a Form

Headers

AuthorizationstringRequired

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

Response

Request was successful
displayNamestring or null
The Form name displayed on the site
createdOnstring or nullformat: "date-time"
Date that the Form was created on
lastUpdatedstring or nullformat: "date-time"
Date that the Form was last updated on
fieldsmap from strings to objects or null
A collection of form field objects
responseSettingsobject or null
Settings for form responses
idstring or nullformat: "objectid"
The unique ID for the Form
siteIdstring or nullformat: "objectid"
The unique ID of the Site the Form belongs to
siteDomainIdstring or nullformat: "objectid"
The unique ID corresponding to the site's Domain name
pageIdstring or nullformat: "objectid"
The unique ID for the Page on which the Form is placed
pageNamestring or null

The user-visible name of the Page where the Form is placed

formElementIdstring or null
The unique ID of the Form element
workspaceIdstring or nullformat: "objectid"
The unique ID of the Workspace the Site belongs to

Errors