List Components | Webflow Developer Documentation

from webflow import Webflow
client = Webflow(
    access_token="YOUR_TOKEN_HERE",
)
client.components.list(
    site_id="580e63e98c9a982ac9b8b741",
    branch_id="68026fa68ef6dc744c75b833",
    limit=100,
    offset=0,
)

{
  "components": [
    {
      "id": "6596da6045e56dee495bcbba",
      "name": "Primary Button",
      "group": "Buttons",
      "description": "A default button component that can be used across the site"
    },
    {
      "id": "658205daa3e8206a523b5ad4",
      "name": "Secondary Button",
      "group": "Buttons",
      "description": "A secondary button component that can be used across the site"
    },
    {
      "id": "6258612d1ee792848f805dcf",
      "name": "Card"
    },
    {
      "id": "68a2b1d1ee792848f805dcf",
      "name": "Nav",
      "readonly": true
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 4
  }
}

List of all components for a site.

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

Query parameters

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

Response

Request was successful

componentslist of objects

paginationobject

Pagination object

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error