Webflow Python SDK

2.0.0 · active · verified Thu Apr 16

The Webflow Python Library provides convenient access to the Webflow Data API from applications written in Python. It includes type definitions for all request and response fields, and offers both synchronous and asynchronous clients powered by `httpx`. The library is actively maintained, with regular updates through Fern regeneration, and is currently at version 2.0.0.

Common errors

```
ModuleNotFoundError: No module named 'webflow'
```
cause The `webflow` library is not installed in the current Python environment.

fix Run `pip install webflow` to install the library.
```
webflow.core.api_error.ApiError: Invalid API Key
```
cause The `access_token` provided to the `Webflow` client is invalid, expired, or lacks the necessary permissions.

fix Verify that your `WEBFLOW_ACCESS_TOKEN` environment variable or hardcoded token is correct and active. Check the permissions associated with your API token in the Webflow dashboard. Some endpoints require Workspace Tokens, while others require Site Tokens.
```
AttributeError: 'Webflow' object has no attribute 'non_existent_method'
```
cause Attempting to call a method or access an attribute on the `Webflow` client that does not exist or has been renamed due to API changes or SDK regeneration.

fix Consult the latest Webflow Python SDK documentation or API reference to ensure you are using the correct method names and object structures, especially after upgrading the library. Refer to the `webflow-python` GitHub README for current usage patterns.

Warnings

breaking Major version bump to v2.0.0 due to 'Fern Regeneration' may introduce breaking changes in API method signatures, response object structures, or enum values. Review the Webflow API reference documentation for specific changes if upgrading from v1.x.
Fix: Consult the official Webflow API documentation and SDK changelog to adapt your code to new method signatures or data structures. Re-generate types if you are relying on code generation.
breaking In v1.2.0, the return type of `assets.list` was changed from an array (`Asset[]`) to an object. Code expecting an array for this endpoint will break.
Fix: Update your code to expect an object (e.g., `client.assets.list().items` if the object contains a list under an 'items' key) instead of directly iterating over the return value of `assets.list()`.
gotcha The SDK relies on `httpcore` for HTTP client functionality. Versions `2.0.0b2` and `2.0.0` included a patch to address a `httpcore` vulnerability. Ensure your environment has the latest patch if you pin `httpcore` or `httpx` versions manually.
Fix: Keep `webflow` library updated to the latest stable version to benefit from security patches, or ensure `httpx` and `httpcore` dependencies are updated to secure versions manually if managing them directly.
gotcha Incorrect OAuth 2.0 configuration, such as misconfigured `redirect_uri`, `client_id`, or `client_secret`, can lead to authentication failures.
Fix: Thoroughly review the OAuth documentation in the Webflow Developer Docs and ensure all parameters (e.g., `client_id`, `client_secret`, `redirect_uri`, `scope`) are correctly configured in both your Webflow App settings and your Python application. Pay attention to authorization URL generation and access token retrieval steps.

Install

pip install webflow Install stable version

Imports

Webflow
```
from webflow.client import Webflow
```
AsyncWebflow
```
from webflow.client import AsyncWebflow
```

Quickstart

Initializes the synchronous Webflow client using an API access token and demonstrates fetching a list of sites. For asynchronous operations, use `AsyncWebflow` and `await` calls.

import os
from webflow.client import Webflow

# It's recommended to store your API token securely, e.g., in an environment variable
WEBFLOW_ACCESS_TOKEN = os.environ.get('WEBFLOW_ACCESS_TOKEN', 'YOUR_WEBFLOW_ACCESS_TOKEN')

if not WEBFLOW_ACCESS_TOKEN or WEBFLOW_ACCESS_TOKEN == 'YOUR_WEBFLOW_ACCESS_TOKEN':
    print("Warning: Please set the WEBFLOW_ACCESS_TOKEN environment variable or replace 'YOUR_WEBFLOW_ACCESS_TOKEN' with your actual token.")
else:
    try:
        client = Webflow(access_token=WEBFLOW_ACCESS_TOKEN)
        # Example: List all sites
        sites_response = client.sites.list()
        if sites_response.sites:
            print(f"Found {len(sites_response.sites)} site(s):")
            for site in sites_response.sites:
                print(f"- Site Name: {site.display_name}, ID: {site.id}")
        else:
            print("No sites found or token lacks sufficient permissions.")
    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →