List Custom Code Blocks

GET

Get a list of scripts that have been applied to a site and/or individual pages.

Script Registration

To apply a script to a site or page, the script must first be registered to a site via the Register Script endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.

See the documentation on working with Custom Code for more information.

Required scope | custom_code:read

Path parameters

site_idstringRequired

Unique identifier for a Site

Query parameters

offsetdoubleOptional

Offset used for pagination if the results have more than limit records

limitdoubleOptional

Maximum number of records to be returned (max limit: 100)

Response

Request was successful

blockslist of objectsOptional

paginationobjectOptional

Pagination object

Errors

GET

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

1 {
2   "blocks": [
3     {
4       "siteId": "6258612d1ee792848f805dcf",
5       "type": "site",
6       "scripts": [
7         {
8           "id": "chartjs",
9           "location": "header",
10           "version": "4.4.2",
11           "attributes": {
12             "key": "value"
13           }
14         }
15       ],
16       "createdOn": "2024-04-03T16:49:15Z",
17       "lastUpdated": "2024-04-03T16:49:15Z"
18     },
19     {
20       "siteId": "6390c49674a71f84b51a08d8",
21       "pageId": "6419db964a9c43f6a3af6348",
22       "type": "page",
23       "scripts": [
24         {
25           "id": "cms_slider",
26           "location": "header",
27           "version": "1.0.0",
28           "attributes": {
29             "my-attribute": "some-value"
30           }
31         },
32         {
33           "id": "alert",
34           "location": "header",
35           "version": "0.0.1",
36           "attributes": {
37             "key": "value"
38           }
39         }
40       ],
41       "createdOn": "2022-10-26T00:28:54Z",
42       "lastUpdated": "2022-10-26T00:28:54Z"
43     }
44   ],
45   "pagination": {
46     "limit": 10,
47     "offset": 0,
48     "total": 1
49   }
50 }

Get Custom Code

Up Next

Built with

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

1	{
2	"blocks": [
3	{
4	"siteId": "6258612d1ee792848f805dcf",
5	"type": "site",
6	"scripts": [
7	{
8	"id": "chartjs",
9	"location": "header",
10	"version": "4.4.2",
11	"attributes": {
12	"key": "value"
13	}
14	}
15	],
16	"createdOn": "2024-04-03T16:49:15Z",
17	"lastUpdated": "2024-04-03T16:49:15Z"
18	},
19	{
20	"siteId": "6390c49674a71f84b51a08d8",
21	"pageId": "6419db964a9c43f6a3af6348",
22	"type": "page",
23	"scripts": [
24	{
25	"id": "cms_slider",
26	"location": "header",
27	"version": "1.0.0",
28	"attributes": {
29	"my-attribute": "some-value"
30	}
31	},
32	{
33	"id": "alert",
34	"location": "header",
35	"version": "0.0.1",
36	"attributes": {
37	"key": "value"
38	}
39	}
40	],
41	"createdOn": "2022-10-26T00:28:54Z",
42	"lastUpdated": "2022-10-26T00:28:54Z"
43	}
44	],
45	"pagination": {
46	"limit": 10,
47	"offset": 0,
48	"total": 1
49	}
50	}