List Components

GET

List of all components for a site Required scope | components:read

Path parameters

site_idstringRequired

Unique identifier for a Site

Query parameters

limitdoubleOptional

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

offsetdoubleOptional

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

Response

Request was successful

componentslist of objectsOptional

paginationobjectOptional

Pagination object

GET

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

200Retrieved

1 {
2   "components": [
3     {
4       "id": "6596da6045e56dee495bcbba",
5       "name": "Primary Button",
6       "group": "Buttons",
7       "description": "A default button component that can be used across the site",
8       "readonly": true
9     },
10     {
11       "id": "658205daa3e8206a523b5ad4",
12       "name": "Secondary Button",
13       "group": "Buttons",
14       "description": "A secondary button component that can be used across the site",
15       "readonly": true
16     },
17     {
18       "id": "6258612d1ee792848f805dcf",
19       "name": "Card",
20       "group": "Buttons",
21       "description": "A button component that can be used across the site",
22       "readonly": true
23     },
24     {
25       "id": "68a2b1d1ee792848f805dcf",
26       "name": "Nav",
27       "group": "Buttons",
28       "description": "A button component that can be used across the site",
29       "readonly": true
30     }
31   ],
32   "pagination": {
33     "limit": 20,
34     "offset": 0,
35     "total": 4
36   }
37 }

Get Component Content

Up Next

Built with

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

1	{
2	"components": [
3	{
4	"id": "6596da6045e56dee495bcbba",
5	"name": "Primary Button",
6	"group": "Buttons",
7	"description": "A default button component that can be used across the site",
8	"readonly": true
9	},
10	{
11	"id": "658205daa3e8206a523b5ad4",
12	"name": "Secondary Button",
13	"group": "Buttons",
14	"description": "A secondary button component that can be used across the site",
15	"readonly": true
16	},
17	{
18	"id": "6258612d1ee792848f805dcf",
19	"name": "Card",
20	"group": "Buttons",
21	"description": "A button component that can be used across the site",
22	"readonly": true
23	},
24	{
25	"id": "68a2b1d1ee792848f805dcf",
26	"name": "Nav",
27	"group": "Buttons",
28	"description": "A button component that can be used across the site",
29	"readonly": true
30	}
31	],
32	"pagination": {
33	"limit": 20,
34	"offset": 0,
35	"total": 4
36	}
37	}