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

locale_idstringOptional

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