Get Component Properties

GET

Get properties of a component definition.

If you do not provide a Locale ID in your request, the response will return any properties 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

propertieslist of objectsOptional

paginationobjectOptional

Pagination object

Errors

GET

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

1 {
2   "componentId": "658205daa3e8206a523b5ad4",
3   "properties": [
4     {
5       "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
6       "type": "Plain Text",
7       "label": "Title",
8       "text": {
9         "text": "The Hitchhiker's Guide to the Galaxy"
10       }
11     },
12     {
13       "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
14       "type": "Rich Text",
15       "label": "Content",
16       "text": {
17         "html": "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
18       }
19     }
20   ],
21   "pagination": {
22     "limit": 2,
23     "offset": 0,
24     "total": 2
25   }
26 }

Update Component Properties

Up Next

Built with

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

1	{
2	"componentId": "658205daa3e8206a523b5ad4",
3	"properties": [
4	{
5	"propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
6	"type": "Plain Text",
7	"label": "Title",
8	"text": {
9	"text": "The Hitchhiker's Guide to the Galaxy"
10	}
11	},
12	{
13	"propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
14	"type": "Rich Text",
15	"label": "Content",
16	"text": {
17	"html": "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>"
18	}
19	}
20	],
21	"pagination": {
22	"limit": 2,
23	"offset": 0,
24	"total": 2
25	}
26	}