Pages and ComponentsComponents

Get Component Properties

Get the default property values of a component definition. <Note>If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale.</Note> Required scope | `components:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
component_idstringRequired
Unique identifier for a Component

Query parameters

localeIdstringOptional

Unique identifier for a specific Locale.

Lear more about localization.

branchIdstringOptionalformat: "objectid"
Scope the operation to work on a specific branch.
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
componentIdstring or null
Component ID
propertieslist of objects or null
paginationobject or null
Pagination object

Errors