Get Form Schema

GET

Get information about a given form.

Required scope | forms:read

Path parameters

form_idstringRequired

Unique identifier for a Form

Response

Request was successful

displayNamestringOptional

The Form name displayed on the site

createdOndatetimeOptional

Date that the Form was created on

lastUpdateddatetimeOptional

Date that the Form was last updated on

fieldsmap from strings to objectsOptional

A collection of form field objects

responseSettingsobjectOptional

Settings for form responses

idstringOptional

The unique ID for the Form

siteIdstringOptional

The unique ID of the Site the Form belongs to

siteDomainIdstringOptional

The unique ID corresponding to the site’s Domain name

pageIdstringOptional

The unique ID for the Page on which the Form is placed

pageNamestringOptional

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

formElementIdstringOptional

The unique ID of the Form element

workspaceIdstringOptional

The unique ID of the Workspace the Site belongs to

Errors

GET

1 curl https://api.webflow.com/v2/forms/580e63e98c9a982ac9b8b741 \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "displayName": "Email Form",
3   "createdOn": "2016-10-24T19:41:29Z",
4   "lastUpdated": "2016-10-24T19:43:17Z",
5   "fields": {
6     "660d5bcc9c0772150459dfb1": {
7       "displayName": "Name",
8       "type": "Plain",
9       "userVisible": true
10     },
11     "589a331aa51e760df7ccb89d": {
12       "displayName": "Email",
13       "type": "Email",
14       "placeholder": "Enter your email",
15       "userVisible": true
16     }
17   },
18   "responseSettings": {
19     "redirectUrl": "https://example.com",
20     "redirectMethod": "GET",
21     "sendEmailConfirmation": true
22   },
23   "id": "589a331aa51e760df7ccb89e",
24   "siteId": "580e63e98c9a982ac9b8b741",
25   "siteDomainId": "6419db964a9c436a4baf6248",
26   "pageId": "6419db964a9c43f6a3af6348",
27   "pageName": "Home",
28   "formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177",
29   "workspaceId": "580e63fc8c9a982ac9b8b744"
30 }

List Form Submissions

Up Next

Built with

1	curl https://api.webflow.com/v2/forms/580e63e98c9a982ac9b8b741 \
2	-H "Authorization: Bearer <token>"

1	{
2	"displayName": "Email Form",
3	"createdOn": "2016-10-24T19:41:29Z",
4	"lastUpdated": "2016-10-24T19:43:17Z",
5	"fields": {
6	"660d5bcc9c0772150459dfb1": {
7	"displayName": "Name",
8	"type": "Plain",
9	"userVisible": true
10	},
11	"589a331aa51e760df7ccb89d": {
12	"displayName": "Email",
13	"type": "Email",
14	"placeholder": "Enter your email",
15	"userVisible": true
16	}
17	},
18	"responseSettings": {
19	"redirectUrl": "https://example.com",
20	"redirectMethod": "GET",
21	"sendEmailConfirmation": true
22	},
23	"id": "589a331aa51e760df7ccb89e",
24	"siteId": "580e63e98c9a982ac9b8b741",
25	"siteDomainId": "6419db964a9c436a4baf6248",
26	"pageId": "6419db964a9c43f6a3af6348",
27	"pageName": "Home",
28	"formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177",
29	"workspaceId": "580e63fc8c9a982ac9b8b744"
30	}