Skip to content
Changelog

Report a bug

Webflow integration: operations for AI agents

Webflow connects to Type.com as an integration. This page lists the 126 operations documented for Claude and Codex in Type.com: 56 read, 44 write, 26 destructive.

About Webflow

Webflow is a no-code website design and hosting platform, letting users build responsive sites, launch online stores, and maintain content without coding

Categories: Developer Tools & IT

How to connect Webflow to Type.com

Connect
Managed OAuth through Pipedream when enabled for your workspace
Access
Organization connection: one shared account for the workspace.
MCP
Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

126 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

126 operations listed.

Meta

  • Read

    Get Authorization User Info

    Information about the Authorized User Required Scope | `authorized_user:read`

    GET /token/authorized_by

  • Read

    Get Authorization Info

    Information about the authorization token <Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/data-clients/getting-started).</Note>

    GET /token/introspect

Sites

  • Read

    List Sites

    List of all sites the provided access token is able to access. Required scope | `sites:read`

    GET /sites

  • Read

    Get Site

    Get details of a site. Required scope | `sites:read`

    GET /sites/{site_id}

  • Read

    Get Custom Domains

    Get a list of all custom domains related to site. Required scope | `sites:read`

    GET /sites/{site_id}/custom_domains

  • Read

    Get 301 redirects

    Fetch a list of all 301 redirect rules configured for a specific site. Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `sites:read`

    GET /sites/{site_id}/redirects

  • Read

    Get Site Plan

    Get site plan details for the specified Site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `sites:read`

    GET /sites/{site_id}/plan

  • Read

    Get robots.txt

    Retrieve the robots.txt configuration for various user agents. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `site_config:read`

    GET /sites/{site_id}/robots_txt

  • Read

    List Google Tags

    List all Google Tag IDs configured for a site, sorted by order. Required scope: `sites:read`

    GET /sites/{site_id}/integrations/google_tags

  • Write

    Create Site

    Create a site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `workspace:write`

    POST /workspaces/{workspace_id}/sites

  • Write

    Update Site

    Update a site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `sites:write`

    PATCH /sites/{site_id}

  • Write

    Publish Site

    Publishes a site or an individual page to one or more domains. If multiple individual pages are published to staging, publishing from staging to production publishes all staged changes. To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint. You must include at least one of the `customDomains` or `publishToWebflowSubdomain` properties in the request body. To publish an individual page instead of the entire site, provide the ID of the page in the `pageId` parameter. <Note title="Rate limit: 1 publish per minute">This endpoint has a specific rate limit of one successful publish queue per minute.</Note> Required scope | `sites:write`

    POST /sites/{site_id}/publish

  • Write

    Create a 301 redirect

    Add a new 301 redirection rule to a site. This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `sites:write`

    POST /sites/{site_id}/redirects

  • Write

    Update 301 redirect

    Update a 301 redirection rule from a site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `sites:write`

    PATCH /sites/{site_id}/redirects/{redirect_id}

  • Write

    Update robots.txt

    Update the `robots.txt` configuration for various user agents. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `site_config:write`

    PATCH /sites/{site_id}/robots_txt

  • Write

    Update Google Tag

    Add or update Google Tag IDs for a site. Existing tags not referenced in the request are preserved. A site may have a maximum of 25 tags total. `order` is optional on input — it is auto-assigned for new tags and returned on all tags in the response. Required scope: `sites:write`

    PATCH /sites/{site_id}/integrations/google_tags

  • Destructive

    Delete Site

    Delete a site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `sites:write`

    DELETE /sites/{site_id}

  • Destructive

    Delete 301 redirects

    Remove a 301 redirection rule from a site. This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `sites:write`

    DELETE /sites/{site_id}/redirects/{redirect_id}

  • Destructive

    Replace robots.txt

    Replace the `robots.txt` configuration for various user agents. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope | `site_config:write`

    PUT /sites/{site_id}/robots_txt

  • Destructive

    Delete robots.txt

    Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior. **Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `site_config:write`

    DELETE /sites/{site_id}/robots_txt

  • Destructive

    Set a well-known file

    Upload a supported well-known file to a site. The current restrictions on well-known files are as follows: - Each file must be smaller than 100kb - Less than 30 total files - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` <Note title=".noext"> `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files. </Note> <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `site_config:write`

    PUT /sites/{site_id}/well_known

  • Destructive

    Delete a well-known file

    Delete existing well-known files from a site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `site_config:write`

    DELETE /sites/{site_id}/well_known

  • Destructive

    Delete Google Tags

    Delete all Google Tag IDs from a site. Required scope: `sites:write`

    DELETE /sites/{site_id}/integrations/google_tags

  • Destructive

    Delete Google Tag

    Delete a single Google Tag ID from a site. The `order` values of the remaining tags are renormalized after deletion. Required scope: `sites:write`

    DELETE /sites/{site_id}/integrations/google_tags/{tag_id}

Workspce Audit Logs

  • Read

    Get Workspace Audit Logs

    Get audit logs for a workspace. <Warning title="Enterprise & workspace API token only">This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint.</Warning> Required scope | `workspace_activity:read`

    GET /workspaces/{workspace_id_or_slug}/audit_logs

Site Activity

  • Read

    Get Site Activity Logs

    Retrieve Activity Logs for a specific Site. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> Required scope: `site_activity:read`

    GET /sites/{site_id}/activity_logs

Analyze

  • Read

    Get Traffic Report

    Returns a daily time series of a single metric — sessions, users, or pageviews — over a time window. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

    GET /sites/{site_id}/analyze/reports/traffic

  • Read

    Get Top Pages Report

    Returns the most-visited pages over a time window, ranked by `sortBy` (sessions, users, or pageviews). Each row carries all three scope counts; `sortBy` only governs ordering. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Set `timeseries[bucketTimeZone]` to attach a daily pageview `timeseries` to each row. Bucket counts are always pageviews regardless of `sortBy` — row-level counts honor the requested sort; the timeseries does not. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

    GET /sites/{site_id}/analyze/reports/top_pages

  • Read

    Get Top Dimensions Report

    Returns the top values within a chosen `dimension` — top countries, top traffic sources, top campaigns, top audiences, and so on — over a time window, ranked by sessions or users. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

    GET /sites/{site_id}/analyze/reports/top_dimensions

  • Read

    Get Top Events Report

    Returns the top events over a time window, ranked by how often they occurred. Events are counted individually, not rolled up into sessions, users, or pageviews — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Set `timeseries[bucketTimeZone]` to attach a daily event count `timeseries` to each row. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

    GET /sites/{site_id}/analyze/reports/top_events

  • Read

    Get Time On Page Report

    Returns the average time on page over a time window — as a single aggregate value, or bucketed by day or week when `timeseries` is supplied. Choose how the average is computed with `metricScope` (per session, user, or pageview). Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

    GET /sites/{site_id}/analyze/reports/time_on_page

Collections

  • Read

    List Collections

    List of all Collections within a Site. Required scope | `cms:read`

    GET /sites/{site_id}/collections

  • Read

    Get Collection Details

    Get the full details of a collection from its ID. Required scope | `cms:read`

    GET /collections/{collection_id}

  • Write

    Create Collection

    Create a Collection for a site with collection fields. Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens. Required scope | `cms:write`

    POST /sites/{site_id}/collections

  • Write

    Update Collection

    Update a collection's display name, singular name, slug, or field groups. **Field group rules:** - A collection can have a maximum of 50 field groups - Each `displayName` must be unique across all field groups in the collection - Each `fieldId` must be unique across all field groups in the collection - Ecommerce collections do not support field groups Required scope | `cms:write`

    PATCH /collections/{collection_id}

  • Write

    Create Collection Field

    Create a custom field in a collection. Field validation is currently not available through the API. Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create) Required scope | `cms:write`

    POST /collections/{collection_id}/fields

  • Write

    Update Collection Field

    Update a custom field in a collection. Required scope | `cms:write`

    PATCH /collections/{collection_id}/fields/{field_id}

  • Destructive

    Delete Collection

    Delete a collection using its ID. Required scope | `cms:write`

    DELETE /collections/{collection_id}

  • Destructive

    Delete Collection Field

    Delete a custom field in a collection. This endpoint does not currently support bulk deletion. Required scope | `cms:write`

    DELETE /collections/{collection_id}/fields/{field_id}

Items

  • Read

    List Collection Items

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> List of all Items within a Collection. <Note> This endpoint supports: - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request. - Custom `sort[...]` queries support up to 3 sort fields per request. </Note> Required scope | `CMS:read`

    GET /collections/{collection_id}/items

  • Read

    List Live Collection Items

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> List all published items in a collection. <Tip title="Serve data with the Content Delivery API"> Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. </Tip> <Note> This endpoint supports: - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request. - Custom `sort[...]` queries support up to 3 sort fields per request. </Note> Required scope | `CMS:read`

    GET /collections/{collection_id}/items/live

  • Read

    Get Collection Item

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Get details of a selected Collection Item. Required scope | `CMS:read`

    GET /collections/{collection_id}/items/{item_id}

  • Read

    Get Live Collection Item

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Get details of a selected Collection live Item. <Tip title="Serve data with the Content Delivery API"> Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. </Tip> Required scope | `CMS:read`

    GET /collections/{collection_id}/items/{item_id}/live

  • Write

    Create Collection Item(s)

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Create Item(s) in a Collection. This endpoint accepts two request shapes, and a request must use one or the other: - **Single item** — send `fieldData` at the top level. Set `cmsLocaleId` to create the item in a specific locale. - **Multiple items** — send an `items` array with at least one entry. Each entry needs its own `fieldData`, and can set its own `cmsLocaleId`, `isDraft`, and `isArchived`. The API ignores any other property on an entry. ```json { "items": [ { "isArchived": false, "isDraft": false, "fieldData": { "name": "Senior Data Analyst", "slug": "senior-data-analyst" } }, { "isArchived": false, "isDraft": false, "fieldData": { "name": "Product Manager", "slug": "product-manager" } } ] } ``` A request that carries both `fieldData` and `items` returns a `400`. To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write`

    POST /collections/{collection_id}/items

  • Write

    Update Collection Items

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Update a single item or multiple items in a Collection. The limit for this endpoint is 100 items. <Tip title="Localization Tip">Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.</Tip> <Note title="Draft status behavior"> `isDraft: true` doesn't unpublish an item. The resulting status depends on whether the item has been published before: - **Item that has never been published:** the item gets a `Draft` status. - **Already-published item:** the item gets a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them. Setting `isDraft: false` queues the item to publish on the next site publish. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live). For the full status mapping, see [Publishing with the CMS API](/data/docs/working-with-the-cms/publishing). </Note> Required scope | `CMS:write`

    PATCH /collections/{collection_id}/items

  • Write

    Create Live Collection Item(s)

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Create item(s) in a collection that will be immediately published to the live site. This endpoint accepts two request shapes, and a request must use one or the other: - **Single item** — send `fieldData` at the top level. Set `cmsLocaleId` to create the item in a specific locale. - **Multiple items** — send an `items` array with at least one entry. Each entry needs its own `fieldData`, and can set its own `cmsLocaleId`, `isDraft`, and `isArchived`. The API ignores any other property on an entry. ```json { "items": [ { "isArchived": false, "isDraft": false, "fieldData": { "name": "Senior Data Analyst", "slug": "senior-data-analyst" } }, { "isArchived": false, "isDraft": false, "fieldData": { "name": "Product Manager", "slug": "product-manager" } } ] } ``` A request that carries both `fieldData` and `items` returns a `400`. To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write`

    POST /collections/{collection_id}/items/live

  • Write

    Update Live Collection Items

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Update a single published item or multiple published items (up to 100) in a Collection <Tip title="Localization Tip">Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.</Tip> Required scope | `CMS:write`

    PATCH /collections/{collection_id}/items/live

  • Write

    Create Collection Items

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Create an item or multiple items in a CMS Collection across multiple corresponding locales. <Note> - This endpoint can create up to 100 items in a request. - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale. </Note> Required scope | `CMS:write`

    POST /collections/{collection_id}/items/bulk

  • Write

    Update Collection Item

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Update a selected Item in a Collection. <Note title="Draft status behavior"> `isDraft: true` doesn't unpublish an item. The resulting status depends on whether the item has been published before: - **Item that has never been published:** the item gets a `Draft` status. - **Already-published item:** the item gets a `Changes in draft` status. The live item stays published, and your changes are held back until you publish them. Setting `isDraft: false` queues the item to publish on the next site publish. To remove an item from the live site, use [Unpublish Live Collection Items](/data/reference/cms/collection-items/live-items/delete-items-live). For the full status mapping, see [Publishing with the CMS API](/data/docs/working-with-the-cms/publishing). </Note> Required scope | `CMS:write`

    PATCH /collections/{collection_id}/items/{item_id}

  • Write

    Update Live Collection Item

    <Tip title="Components in Rich Text"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop name="<propId>" type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, contains a Collection List, populates a Slot (a component with an unpopulated Slot is allowed), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Tip> Update a selected live Item in a Collection. The updates for this Item will be published to the live site. Required scope | `CMS:write`

    PATCH /collections/{collection_id}/items/{item_id}/live

  • Write

    Publish Collection Item

    Publish an item or multiple items. Required scope | `cms:write`

    POST /collections/{collection_id}/items/publish

  • Destructive

    Delete Collection Items

    Delete Items from a Collection. <Tip title="Localization Tip">Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request.</Tip> Required scope | `CMS:write`

    DELETE /collections/{collection_id}/items

  • Destructive

    Unpublish Live Collection Items

    Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. <Tip title="Localization Tip">Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.</Tip> Required scope | `CMS:write`

    DELETE /collections/{collection_id}/items/live

  • Destructive

    Delete Collection Item

    Delete an item from a collection. Required scope | `CMS:write`

    DELETE /collections/{collection_id}/items/{item_id}

  • Destructive

    Unpublish Live Collection Item

    Unpublish a live item from the site and set the `isDraft` property to `true`. For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live) Required scope | `CMS:write`

    DELETE /collections/{collection_id}/items/{item_id}/live

Comments

  • Read

    List Comment Threads

    List all comment threads for a site. <Note title="Timing of comment threads"> There may be a delay of up to 5 minutes before new comments appear in the system. </Note> Required scope | `comments:read`

    GET /sites/{site_id}/comments

  • Read

    Get Comment Thread

    Get details of a specific comment thread. <Note title="Timing of comment threads"> There may be a delay of up to 5 minutes before new comments appear in the system. </Note> Required scope | `comments:read`

    GET /sites/{site_id}/comments/{comment_thread_id}

  • Read

    List Comment Replies

    List all replies to a specific comment thread. <Note title="Timing of comment threads"> There may be a delay of up to 5 minutes before new comments appear in the system. </Note> Required scope | `comments:read`

    GET /sites/{site_id}/comments/{comment_thread_id}/replies

  • Write

    Resolve Comment Thread

    Resolve or unresolve a comment thread. <Note> This endpoint is rate limited to 60 requests per minute per site. </Note> Required scope | `comments:write`

    PATCH /sites/{site_id}/comments/{comment_thread_id}

  • Write

    Create Comment Reply

    Create a reply to an existing comment thread. The reply author is always the user who authorized the OAuth token. To @mention a user in the reply, include their user ID in double square brackets in the `content` field, as in `[[userId]]`. <Note> The `comment_created` webhook fires automatically when a reply is created. </Note> Required scope | `comments:write`

    POST /sites/{site_id}/comments/{comment_thread_id}/replies

Pages

  • Read

    List Pages

    List of all pages for a site. Required scope | `pages:read`

    GET /sites/{site_id}/pages

  • Read

    Get Page Metadata

    Get metadata information for a single page. Required scope | `pages:read`

    GET /pages/{page_id}

  • Read

    Get Page Content

    Get text and component instance content from a static page. <Badge intent="info">Localization</Badge> Required scope | `pages:read`

    GET /pages/{page_id}/dom

  • Write

    Update Page Content

    This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types. 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. <Note> This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. </Note> Required scope | `pages:write`

    POST /pages/{page_id}/dom

  • Destructive

    Update Page Metadata

    Update Page-level metadata, including SEO and Open Graph fields. Required scope | `pages:write`

    PUT /pages/{page_id}

Components

  • Read

    List Components

    List of all components for a site. Required scope | `components:read`

    GET /sites/{site_id}/components

  • Read

    Get Component Content

    Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. <Note>If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.</Note> Required scope | `components:read`

    GET /sites/{site_id}/components/{component_id}/dom

  • Read

    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`

    GET /sites/{site_id}/components/{component_id}/properties

  • Write

    Update Component Content

    This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types. 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. <Note> This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. </Note> Required scope | `components:write`

    POST /sites/{site_id}/components/{component_id}/dom

  • Write

    Update Component Properties

    Update the default property values of a component definition in a specificed locale. Before making updates: 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. 2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. <Note>The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error.</Note> Required scope | `components:write`

    POST /sites/{site_id}/components/{component_id}/properties

Custom Code Pages

  • Read

    Get Custom Code

    Get all scripts applied to a page. <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:read`

    GET /pages/{page_id}/custom_code

  • Destructive

    Add/Update Custom Code

    Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. <Note title="Script Registration"> To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:write`

    PUT /pages/{page_id}/custom_code

  • Destructive

    Delete Custom Code

    Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts. To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint. <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:write`

    DELETE /pages/{page_id}/custom_code

Custom Code Sites

  • Read

    Get Custom Code

    Get all scripts applied to a site by the App. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:read`

    GET /sites/{site_id}/custom_code

  • Destructive

    Add/Update Custom Code

    Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:write`

    PUT /sites/{site_id}/custom_code

  • Destructive

    Delete Custom Code

    Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts. To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint. <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:write`

    DELETE /sites/{site_id}/custom_code

Custom Code

  • Read

    Get Registered Scripts

    Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:read`

    GET /sites/{site_id}/registered_scripts

  • Read

    List Custom Code Blocks

    Get a list of scripts that have been applied to a site and/or individual pages. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:read`

    GET /sites/{site_id}/custom_code/blocks

  • Write

    Register Script - Hosted

    Register a hosted script to a site. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:write`

    POST /sites/{site_id}/registered_scripts/hosted

  • Write

    Register Script - Inline

    Register an inline script to a site. Inline scripts are limited to 2000 characters. <Note title="Script Registration"> To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. </Note> <Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note> Required scope | `custom_code:write`

    POST /sites/{site_id}/registered_scripts/inline

Assets

  • Read

    List Assets

    List of assets uploaded to a site Required scope | `assets:read`

    GET /sites/{site_id}/assets

  • Read

    Get Asset

    Get details about an asset Required scope | `assets:read`

    GET /assets/{asset_id}

  • Write

    Upload Asset

    The first step in uploading an asset to a site. This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload. To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets). Required scope | `assets:write`

    POST /sites/{site_id}/assets

  • Write

    Update Asset

    Update details of an Asset. Required scope | `assets:write`

    PATCH /assets/{asset_id}

  • Destructive

    Delete Asset

    Delete an Asset Required Scope: `assets: write`

    DELETE /assets/{asset_id}

Asset Folders

  • Read

    List Asset Folders

    List Asset Folders within a given site Required scope | `assets:read`

    GET /sites/{site_id}/asset_folders

  • Read

    Get Asset Folder

    Get details about a specific Asset Folder Required scope | `assets:read`

    GET /asset_folders/{asset_folder_id}

  • Write

    Create Asset Folder

    Create an Asset Folder within a given site Required scope | `assets:write`

    POST /sites/{site_id}/asset_folders

Custom Fonts

  • Read

    List custom fonts

    List the custom fonts uploaded to a site. Required scope | `sites:read`

    GET /sites/{site_id}/custom_fonts

  • Read

    Get custom font

    Get details about a custom font on a site. Required scope | `sites:read`

    GET /sites/{site_id}/custom_fonts/{font_id}

  • Write

    Create custom font

    Register a custom font on a site and get a presigned S3 URL to upload the font binary. The response includes a `customFont` object and an `upload` object. Use the `upload.url` and `upload.fields` to POST the font binary directly to S3 as `multipart/form-data`. The binary must go in a field named `file` and must be the last field in the form (an AWS S3 requirement). S3 returns `201 Created` on a successful upload. To learn more, see [Custom fonts](/data/docs/custom-fonts). Required scope | `sites:write`

    POST /sites/{site_id}/custom_fonts

  • Write

    Update custom font

    Update the metadata of a custom font. The font binary is not changed by this endpoint. To replace the binary, use [Replace custom font file](#operation/replace-custom-font-file). The request body must include at least one of `fontFamily`, `weight`, `italic`, or `fontDisplay`. Required scope | `sites:write`

    PATCH /sites/{site_id}/custom_fonts/{font_id}

  • Write

    Batch create custom fonts

    Register 1–25 custom fonts in a single request and get a presigned S3 URL for each one. This collapses the registration step for a whole font family (for example, Regular, Bold, Italic, and Bold Italic) into one rate-limited request. Registration is batched, but the binary uploads are not: the response contains one `upload` object per registered font, and you must POST each font binary to its own presigned S3 URL exactly as you would for [Create custom font](#operation/create-custom-font). The Webflow API server never receives the raw font bytes. The response is `200 OK` for a valid request body. Per-font results are reported in the `created` and `failed` arrays. If the site's font limit is reached partway through the batch, the fonts that still fit are registered and returned in `created`, while the rest appear in `failed` with `name: "FontLimitReached"` — valid fonts are never discarded because a later font in the same batch could not be registered. Each presigned URL expires approximately 15 minutes after issuance, so upload the binaries promptly. Required scope | `sites:write`

    POST /sites/{site_id}/custom_fonts/batchCreate

  • Destructive

    Delete custom font

    Delete a custom font from a site. Required scope | `sites:write`

    DELETE /sites/{site_id}/custom_fonts/{font_id}

  • Destructive

    Replace custom font file

    Replace the binary of an existing custom font while preserving its ID and any references to it. The upload handshake is identical to [Create custom font](#operation/create-custom-font). If the existing font has a non-empty `axes` array (a variable font), you must include an `axes` field in the request. Send `axes: []` to declare that the new binary is a static font, or send the new variable axes to declare it is still variable. Omitting `axes` when the existing font is variable returns `400`. Required scope | `sites:write`

    PUT /sites/{site_id}/custom_fonts/{font_id}/file

  • Destructive

    Batch delete custom fonts

    Delete 1-100 custom fonts in a single request. The response is always `200 OK` for a valid request body. Per-font results are reported in the `deleted` and `failed` arrays. The endpoint is idempotent: fonts that do not exist appear in `failed` with `name: "NotFound"` rather than failing the entire request. You can safely retry a partial failure by re-sending only the IDs that did not appear in `deleted`. Required scope | `sites:write`

    POST /sites/{site_id}/custom_fonts/batchDelete

Webhooks

  • Read

    List Webhooks

    List all App-created Webhooks registered for a given site Required scope | `sites:read`

    GET /sites/{site_id}/webhooks

  • Read

    Get Webhook

    Get a specific Webhook instance Required scope: `sites:read`

    GET /webhooks/{webhook_id}

  • Write

    Create Webhook

    Create a new Webhook. Limit of 75 registrations per `triggerType`, per site. <Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/data-clients/getting-started).</Note> Required scope | `sites:write`

    POST /sites/{site_id}/webhooks

  • Destructive

    Remove Webhook

    Remove a Webhook Required scope: `sites:read`

    DELETE /webhooks/{webhook_id}

Forms

  • Read

    List Forms

    List forms for a given site. Required scope | `forms:read`

    GET /sites/{site_id}/forms

  • Read

    Get Form Schema

    Get information about a given form. Required scope | `forms:read`

    GET /forms/{form_id}

  • Read

    List Form Submissions

    List form submissions for a given form ID within a specific site. Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. Required scope | `forms:read`

    GET /forms/{form_id}/submissions

  • Read

    Get Form Submission

    Get information about a given form submissio. Required scope | `forms:read`

    GET /form_submissions/{form_submission_id}

  • Read

    List Form Submissions by Site

    List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`. Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response). <Note title="Forms in components"> When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components. </Note> Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID. Required scope | `forms:read`

    GET /sites/{site_id}/form_submissions

  • Read

    List Form Submissions

    List form submissions for a given form ID within a specific site. Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. Required scope | `forms:read`

    GET /sites/{site_id}/forms/{form_id}/submissions

  • Read

    Get Form Submission by Site

    Get information about a form submission within a specific site. Required scope | `forms:read`

    GET /sites/{site_id}/form_submissions/{form_submission_id}

  • Write

    Modify Form Submission

    Update hidden fields on a form submission Required scope | `forms:write`

    PATCH /form_submissions/{form_submission_id}

  • Write

    Modify Form Submission by Site

    Update hidden fields on a form submission within a specific site. Required scope | `forms:write`

    PATCH /sites/{site_id}/form_submissions/{form_submission_id}

  • Destructive

    Delete Form Submission

    Delete a form submission Required scope | `forms:write`

    DELETE /form_submissions/{form_submission_id}

  • Destructive

    Delete Form Submission by Site

    Delete a form submission within a specific site. Required scope | `forms:write`

    DELETE /sites/{site_id}/form_submissions/{form_submission_id}

Products & SKUs

  • Read

    List Products & SKUs

    Retrieve all products for a site. Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs. Required scope | `ecommerce:read`

    GET /sites/{site_id}/products

  • Read

    Get Product and SKUs

    Retrieve a single product by its ID. All of its SKUs will also be retrieved. Required scope | `ecommerce:read`

    GET /sites/{site_id}/products/{product_id}

  • Write

    Create Product & SKU

    Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU. To create a product with multiple SKUs: - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large. - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt) - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku) Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. Required scope | `ecommerce:write`

    POST /sites/{site_id}/products

  • Write

    Update Product

    Update an existing Product. Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. Required scope | `ecommerce:write`

    PATCH /sites/{site_id}/products/{product_id}

  • Write

    Create SKUs

    Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants) Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. Required scope | `ecommerce:write`

    POST /sites/{site_id}/products/{product_id}/skus

  • Write

    Update SKU

    Update a specified SKU. Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. Required scope | `ecommerce:write`

    PATCH /sites/{site_id}/products/{product_id}/skus/{sku_id}

Orders

  • Read

    List Orders

    List all orders created for a given site. Required scope | `ecommerce:read`

    GET /sites/{site_id}/orders

  • Read

    Get Order

    Retrieve a single product by its ID. All of its SKUs will also be retrieved. Required scope | `ecommerce:read`

    GET /sites/{site_id}/orders/{order_id}

  • Write

    Update Order

    This API lets you update the fields, `comment`, `shippingProvider`, and/or `shippingTracking` for a given order. All three fields can be updated simultaneously or independently. Required scope | `ecommerce:write`

    PATCH /sites/{site_id}/orders/{order_id}

  • Write

    Fulfill Order

    Updates an order's status to fulfilled Required scope | `ecommerce:write`

    POST /sites/{site_id}/orders/{order_id}/fulfill

  • Write

    Unfulfill Order

    Updates an order's status to unfulfilled Required scope | `ecommerce:write`

    POST /sites/{site_id}/orders/{order_id}/unfulfill

  • Write

    Refund Order

    This API will reverse a Stripe charge and refund an order back to a customer. It will also set the order's status to `refunded`. Required scope | `ecommerce:write`

    POST /sites/{site_id}/orders/{order_id}/refund

Inventory

  • Read

    List Inventory

    List the current inventory levels for a particular SKU item. Required scope | `ecommerce:read`

    GET /collections/{sku_collection_id}/items/{sku_id}/inventory

  • Write

    Update Item Inventory

    Updates the current inventory levels for a particular SKU item. Updates may be given in one or two methods, absolutely or incrementally. - Absolute updates are done by setting `quantity` directly. - Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server. Required scope | `ecommerce:write`

    PATCH /collections/{sku_collection_id}/items/{sku_id}/inventory

Settings

  • Read

    Get Ecommerce Settings

    Retrieve ecommerce settings for a site. Required scope | `ecommerce:read`

    GET /sites/{site_id}/ecommerce/settings

Get started

  1. Open Space settings → Connections and search for Webflow.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.