Webflow Data API

Webflow Data API Documentation

This skill provides comprehensive documentation for the Webflow Data API v2.0.0 - a RESTful API for managing sites, CMS content, pages, forms, ecommerce, and more.

Document Structure

• ## marks documentation topic areas
• ### marks individual documentation pages with clickable links
• Nested bullets show the main sections within each page

Getting Started

quick-start

• Before you start
• Quick Start (5 minutes)
• Clone the starter app
• Add credentials
• Start the server

structure-1

• API structure and response objects

oauth-app

• Creating OAuth applications

Authentication & Authorization

authentication

• Authentication methods and flows

site-token

• Site-specific access tokens

workspace-token

• Workspace-level access tokens

scopes

• OAuth scopes and permissions

authorized-by

• Check token authorization

introspect

• Token introspection

Core Concepts

rate-limits

• API rate limiting

error-handling

• Error codes and handling

versioning

• API versioning strategy

Migration & Deprecation

migrating-to-v2

• Migrating from v1 to v2

webflow-v1-api-deprecation-notice

• V1 API deprecation timeline

Sites

list

• List all sites

get

• Get site details

get-custom-domain

• Get custom domain info

publish

• Publish site

Pages & Components

Pages

• list - List pages
• get-metadata - Get page metadata
• update-page-settings - Update page settings
• get-content - Get page content
• update-static-content - Update static content

Components

• list - List components
• get-content - Get component content
• update-content - Update component content
• get-properties - Get component properties
• update-properties - Update component properties

CMS

cms

• Overview
• Workflows
• Key concepts
  • Collections
  • Collection fields
  • Collection items
• Bulk operations
• Webhooks

Collections

• list - List collections
• get - Get collection
• create - Create collection
• delete - Delete collection

Collection Fields

• create - Create field
• update - Update field
• delete - Delete field

field-types-item-values

• Field types and item values reference

Staged Items

• list-items - List staged items
• get-item - Get staged item
• create-items - Create items
• update-items - Update items
• delete-items - Delete items
• publish-item - Publish item

Live Items

• list-items-live - List live items
• get-item-live - Get live item
• create-item-live - Create live item
• update-items-live - Update live items
• delete-items-live - Delete/unpublish live items

Forms

Forms

• list - List forms
• get - Get form

Form Submissions

• list-submissions - List submissions
• get-submission - Get submission
• list-submissions-by-site - List by site
• update-submission - Update submission
• delete-submission - Delete submission

Custom Code

Custom Code Blocks

• list - List custom code
• register-hosted - Register hosted code
• register-inline - Register inline code
• list-custom-code-blocks - List code blocks

Site-Level Custom Code

• get-custom-code - Get site custom code
• upsert-custom-code - Upsert site custom code
• delete-custom-code - Delete site custom code

Page-Level Custom Code

• get-custom-code - Get page custom code
• delete-custom-code - Delete page custom code

Assets

Assets

• list - List assets
• get - Get asset
• create - Create asset
• update - Update asset
• delete - Delete asset

Asset Folders

• list-folders - List folders
• get-folder - Get folder
• create-folder - Create folder

Comments

• list-comment-threads - List comment threads
• get-comment-thread - Get comment thread
• list-comment-replies - List comment replies

Users

Users

• list - List users
• get - Get user
• delete - Delete user
• update - Update user
• invite - Invite user

Access Groups

• list - List access groups

Ecommerce

Products

• list - List products
• create - Create product
• get - Get product
• update - Update product
• create-sku - Create SKU
• update-sku - Update SKU

Orders

• list - List orders
• get - Get order
• update - Update order
• update-fulfill - Fulfill order
• update-unfulfill - Unfulfill order
• refund - Refund order

Inventory

• update - Update inventory

Settings

• get-settings - Get ecommerce settings

Webhooks

Webhook Management

• list - List webhooks
• get - Get webhook
• create - Create webhook
• delete - Delete webhook

Webhook Events

• form-submission - Form submission event
• site-publish - Site publish event
• page-created - Page created event
• page-metadata-updated - Page metadata updated
• page-deleted - Page deleted event
• collection-item-created - Item created event
• collection-item-changed - Item changed event
• collection-item-deleted - Item deleted event
• collection-item-published - Item published event
• collection-item-unpublished - Item unpublished event
• user-account-added - User account added event
• user-account-updated - User account updated event
• user-account-deleted - User account deleted event
• ecomm-new-order - New order event
• ecomm-order-changed - Order changed event
• ecomm-inventory-changed - Inventory changed event
• comment-created - Comment created event

Enterprise Features

Workspace Audit Logs

• get - Get audit logs
• event-types - Audit log event types

Site Activity Logs

• list - List site activity logs

Site Configuration - 301 Redirects

• create - Create redirect
• get - Get redirect
• patch - Update redirect
• delete - Delete redirect

Site Configuration - Robots.txt

• put - Create/replace robots.txt
• get - Get robots.txt
• patch - Update robots.txt
• delete - Delete robots.txt

Site Configuration - Well-known Files

• delete - Delete well-known file

Workspace Management

• create - Create workspace
• update - Update workspace
• delete - Delete workspace
• get-site-plan - Get site plan

Specific Solutions, Tips & Workarounds

• CMS Tips