Get Component Content

GET

Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. To retrieve dynamic content set by component properties, use the get component properties endpoint.

If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.

Required scope | components:read

Path parameters

site_idstringRequired

Unique identifier for a Site

component_idstringRequired

Unique identifier for a Component

Query parameters

localeIdstringOptional

Unique identifier for a specific locale. Applicable, when using localization.

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

componentIdstringOptional

Component ID

nodeslist of objectsOptional

paginationobjectOptional

Pagination object

Errors

GET

1 curl -G https://api.webflow.com/beta/sites/580e63e98c9a982ac9b8b741/components/8505ba55-ef72-629e-f85c-33e4b703d48b/dom \
2      -H "Authorization: Bearer <token>" \
3      -d localeId=65427cf400e02b306eaa04a0

200Retrieved

1 {
2   "componentId": "69118560-d0bc-15fc-bbf8-b8fe5f6535b5",
3   "nodes": [
4     {
5       "type": "text",
6       "id": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
7       "text": {
8         "html": "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
9         "text": "The Hitchhiker's Guide to the Galaxy"
10       },
11       "attributes": {
12         "key": "value"
13       }
14     },
15     {
16       "type": "text",
17       "id": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
18       "text": {
19         "html": "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
20       },
21       "attributes": {
22         "number": "forty two"
23       }
24     },
25     {
26       "type": "image",
27       "id": "a245c12d-995b-55ee-5ec7-aa36a6cad629",
28       "image": {
29         "alt": "Marvin, the Paranoid Android",
30         "assetId": "659595234426a9fcbad57043"
31       },
32       "attributes": {
33         "key": "value"
34       }
35     },
36     {
37       "type": "text-input",
38       "id": "6e468d51-8942-f7be-34cc-347b0e24e118",
39       "placeholder": "Search…",
40       "attributes": {
41         "key": "value"
42       }
43     },
44     {
45       "type": "select",
46       "choices": [
47         {
48           "value": "Magrathea",
49           "text": "Magrathea"
50         },
51         {
52           "value": "mostly-harmless",
53           "text": "Earth"
54         },
55         {
56           "value": "Vogsphere",
57           "text": "Vogsphere"
58         }
59       ],
60       "id": "82cdcd0b-b9c7-0ddc-0519-bc1fa02de26e",
61       "attributes": {
62         "key": "value"
63       }
64     },
65     {
66       "type": "submit-button",
67       "id": "9fa3a9c4-87d4-19b0-95f7-1b0b099f82ab",
68       "value": "Subscribe",
69       "waitingText": "Please wait...",
70       "attributes": {
71         "key": "value"
72       }
73     },
74     {
75       "type": "component-instance",
76       "componentId": "6258612d1ee792848f805dcf",
77       "id": "a245c12d-995b-55ee-5ec7-aa36a6cad631",
78       "propertyOverrides": [
79         {
80           "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad633",
81           "type": "Plain Text",
82           "text": {
83             "text": "Don't Panic!"
84           }
85         },
86         {
87           "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad635",
88           "type": "Rich Text",
89           "text": {
90             "html": "<div><p>Always know where your towel is.</p></div>"
91           }
92         }
93       ]
94     }
95   ],
96   "pagination": {
97     "limit": 7,
98     "offset": 0,
99     "total": 7
100   }
101 }

Update Component Content

Up Next

Built with

1	curl -G https://api.webflow.com/beta/sites/580e63e98c9a982ac9b8b741/components/8505ba55-ef72-629e-f85c-33e4b703d48b/dom \
2	-H "Authorization: Bearer <token>" \
3	-d localeId=65427cf400e02b306eaa04a0

1	{
2	"componentId": "69118560-d0bc-15fc-bbf8-b8fe5f6535b5",
3	"nodes": [
4	{
5	"type": "text",
6	"id": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
7	"text": {
8	"html": "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
9	"text": "The Hitchhiker's Guide to the Galaxy"
10	},
11	"attributes": {
12	"key": "value"
13	}
14	},
15	{
16	"type": "text",
17	"id": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
18	"text": {
19	"html": "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
20	},
21	"attributes": {
22	"number": "forty two"
23	}
24	},
25	{
26	"type": "image",
27	"id": "a245c12d-995b-55ee-5ec7-aa36a6cad629",
28	"image": {
29	"alt": "Marvin, the Paranoid Android",
30	"assetId": "659595234426a9fcbad57043"
31	},
32	"attributes": {
33	"key": "value"
34	}
35	},
36	{
37	"type": "text-input",
38	"id": "6e468d51-8942-f7be-34cc-347b0e24e118",
39	"placeholder": "Search…",
40	"attributes": {
41	"key": "value"
42	}
43	},
44	{
45	"type": "select",
46	"choices": [
47	{
48	"value": "Magrathea",
49	"text": "Magrathea"
50	},
51	{
52	"value": "mostly-harmless",
53	"text": "Earth"
54	},
55	{
56	"value": "Vogsphere",
57	"text": "Vogsphere"
58	}
59	],
60	"id": "82cdcd0b-b9c7-0ddc-0519-bc1fa02de26e",
61	"attributes": {
62	"key": "value"
63	}
64	},
65	{
66	"type": "submit-button",
67	"id": "9fa3a9c4-87d4-19b0-95f7-1b0b099f82ab",
68	"value": "Subscribe",
69	"waitingText": "Please wait...",
70	"attributes": {
71	"key": "value"
72	}
73	},
74	{
75	"type": "component-instance",
76	"componentId": "6258612d1ee792848f805dcf",
77	"id": "a245c12d-995b-55ee-5ec7-aa36a6cad631",
78	"propertyOverrides": [
79	{
80	"propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad633",
81	"type": "Plain Text",
82	"text": {
83	"text": "Don't Panic!"
84	}
85	},
86	{
87	"propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad635",
88	"type": "Rich Text",
89	"text": {
90	"html": "<div><p>Always know where your towel is.</p></div>"
91	}
92	}
93	]
94	}
95	],
96	"pagination": {
97	"limit": 7,
98	"offset": 0,
99	"total": 7
100	}
101	}