Get Component Properties | Webflow Developer Documentation

curl -G https://api.webflow.com/v2/sites/580e63e98c9a982ac9b8b741/components/8505ba55-ef72-629e-f85c-33e4b703d48b/properties \
     -H "Authorization: Bearer <token>" \
     -d localeId=65427cf400e02b306eaa04a0 \
     -d branchId=68026fa68ef6dc744c75b833 \
     -d limit=100 \
     -d offset=0 \
     -d translatable=65427cf400e02b306eaa04a0

{
  "componentId": "658205da-a3e8-4206-a523-b5ad4fabcdef",
  "properties": [
    {
      "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad623",
      "type": "Plain Text",
      "label": "Title",
      "text": {
        "html": null,
        "text": "The Hitchhiker's Guide to the Galaxy"
      }
    },
    {
      "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad627",
      "type": "Rich Text",
      "label": "Content",
      "text": {
        "html": "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>",
        "text": null
      }
    }
  ],
  "pagination": {
    "limit": 2,
    "offset": 0,
    "total": 2
  }
}

Get the default property values of a component definition.

If you do not include a localeId in your request, the response will return any properties that can be localized from the Primary locale.

Required scope | components:read

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.

Learn more about localization.

branchIdstringOptionalformat: "objectid"

Scope the operation to work on a specific branch.

limitintegerOptional

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

offsetintegerOptional

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

translatablestringOptional

Unique identifier for the secondary Locale you’re translating into. Returns only content that hasn’t been excluded from translation for that locale.

This is independent of localeId, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale’s content and set translatable to the locale you’re translating into:

?localeId={primary locale id}&translatable={target locale id}

Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don’t affect this parameter’s response.

Omitting translatable returns the same response as if this parameter didn’t exist. The value must be the id of one of the site’s secondary locales — the primary locale id, or any other value, returns a 400 error. Requires translation exclusions to be enabled for the site; if they aren’t, the request returns a 403 error.

Learn more about localization.

Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale. This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into: `?localeId={primary locale id}&translatable={target locale id}` Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response. Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error. [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)

Response

Request was successful

componentIdstringOptionalRead-only

Component ID

propertieslist of objectsOptional

paginationobjectOptional

Pagination object

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Unique identifier for the secondary Locale you’re translating into. Returns only content that hasn’t been excluded from translation for that locale.

?localeId={primary locale id}&translatable={target locale id}

Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don’t affect this parameter’s response.

Learn more about localization.