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

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Date that the Form was created on

lastUpdateddatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

Date that the Form was last updated on

fieldslist of maps from strings to objectsOptional

A list of form fields

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>"

1 {
2   "displayName": "Email Form",
3   "createdOn": "2016-10-24T19:41:29Z",
4   "lastUpdated": "2016-10-24T19:43:17Z",
5   "fields": [
6     {
7       "660d5bcc9c0772150459dfb1": {
8         "displayName": "Email",
9         "userVisible": true
10       },
11       "displayName": {
12         "displayName": "Email",
13         "userVisible": true
14       },
15       "type": {
16         "displayName": "Email",
17         "userVisible": true
18       },
19       "placeholder": {
20         "displayName": "Email",
21         "userVisible": true
22       },
23       "userVisible": {
24         "displayName": "Email",
25         "userVisible": true
26       }
27     },
28     {
29       "589a331aa51e760df7ccb89d": {
30         "displayName": "Email",
31         "type": "Email",
32         "placeholder": "Enter your email",
33         "userVisible": true
34       }
35     }
36   ],
37   "responseSettings": {
38     "redirectUrl": "https://example.com",
39     "redirectMethod": "GET",
40     "redirectAction": "POST https://example.com",
41     "sendEmailConfirmation": true
42   },
43   "id": "589a331aa51e760df7ccb89e",
44   "siteId": "580e63e98c9a982ac9b8b741",
45   "siteDomainId": "6419db964a9c436a4baf6248",
46   "pageId": "6419db964a9c43f6a3af6348",
47   "pageName": "Home",
48   "formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177",
49   "workspaceId": "580e63fc8c9a982ac9b8b744"
50 }

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	{
7	"660d5bcc9c0772150459dfb1": {
8	"displayName": "Email",
9	"userVisible": true
10	},
11	"displayName": {
12	"displayName": "Email",
13	"userVisible": true
14	},
15	"type": {
16	"displayName": "Email",
17	"userVisible": true
18	},
19	"placeholder": {
20	"displayName": "Email",
21	"userVisible": true
22	},
23	"userVisible": {
24	"displayName": "Email",
25	"userVisible": true
26	}
27	},
28	{
29	"589a331aa51e760df7ccb89d": {
30	"displayName": "Email",
31	"type": "Email",
32	"placeholder": "Enter your email",
33	"userVisible": true
34	}
35	}
36	],
37	"responseSettings": {
38	"redirectUrl": "https://example.com",
39	"redirectMethod": "GET",
40	"redirectAction": "POST https://example.com",
41	"sendEmailConfirmation": true
42	},
43	"id": "589a331aa51e760df7ccb89e",
44	"siteId": "580e63e98c9a982ac9b8b741",
45	"siteDomainId": "6419db964a9c436a4baf6248",
46	"pageId": "6419db964a9c43f6a3af6348",
47	"pageName": "Home",
48	"formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177",
49	"workspaceId": "580e63fc8c9a982ac9b8b744"
50	}