Webflow API: Changed Endpoints

As part of our launch on Tuesday, August 29th, we are launching a new version of our API. The following API endpoints will be changing in the new API version

Meta

GET /token/authorized_by

Authorization User Info, replaces /user endpoint

GET /token/introspect

Authorization Info, replaces /info endpoint

Sites

GET /sites

Return Type:

• Added property sites (object)

  • Renamed property _id to id (object)

    Unique identifier for the Site

  • Added property workspaceId (object)

    Unique identifier for the Workspace

  • Rename property name to displayName (object)

    Name given to Site

  • Added property lastUpdated (object)

    Date the Site was last updated

  • Renamed property timezone to timeZone (object)

    Site timezone set under Site Settings

  • Deleted property database

GET /sites/{site_id}

Return Type:

• Renamed property _id to id (object)

  Unique identifier for the Site

• Added property workspaceId (object)

  Unique identifier for the Workspace

• Rename property name to displayName (object)

  Name given to Site

• Added property lastUpdated (object)

  Date the Site was last updated

• Renamed property timezone to timeZone (object)

  Site timezone set under Site Settings

• Added property customDomains (object)

• Deleted property database

POST /sites/{site_id}/publish

Publish site

Request:

• Renamed property domains to customDomains (object)

  Array of Custom Domain ids to publish

• Added property publishToWebflowSubdomain (object)

  Choice of whether to publish to the default Webflow Subdomain

CMS

GET /sites/{site_id}/collections

List Collections

Return Type:

• Added property collections (object)

  An array of Collections

  • Renamed property _id to id (object)

    Unique identifier for a Collection

GET /collections/{collection_id}

Get Collection Details

Return Type:

• Renamed property _id to id (object)

  Unique identifier for a Collection

• Renamed property name to displayName (object)

  Name given to the Collection

• Changed property fields (object)

  The list of fields in the Collection

  • Renamed property _id to id (object)

    Unique identifier for a field

  • Renamed property editable to isEditable

    Flag to denote a field as editable

  • Renamed property required to isRequired

    Flag to denote a field as required

  • Renamed property name to displayName (object)

    Name given to the field

  • Added property helpText

GET /collections/{collection_id}/items

Return Type:

• Renamed property _id to id (object)

  Unique identifier for the Item

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property created-on to CreatedOn

  The date the item was created

• Renamed property updated-on to lastUpdated

  The date the item was last updated

• Renamed property published-on to lastPublished

  The date the item was last published

• Added property pagination (object)

  • Property limit (object)

    The limit specified in the request

  • Property offset (object)

    The offset specified for pagination

  • Property total (object)

    Total number of items in the collection

• Deleted property count (object)

  Number of items returned

POST /collections/{collection_id}/items

Parameters:

Deleted: live in query

Boolean indicating if the item(s) should be published/unpublished to/from the live site

Request:

Details of the item to create

• Added property isArchived (object)

  Boolean determining if the Item is set to archived

• Added property isDraft (object)

  Boolean determining if the Item is set to draft

• Added property fieldData (object)

  • Property name (object)

    Name of the Item

  • Property slug (object)

    URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.

• Deleted property fields (object)

  The fields for the new item

Return Type:

• Renamed property _id to id (object)

  Unique identifier for the Item

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property created-on to CreatedOn

  The date the item was created

• Renamed property updated-on to lastUpdated

  The date the item was last updated

• Renamed property published-on to lastPublished

  The date the item was last published

• Added property fieldData (object)

• Deleted property name (object)

  Name given to the Item

• Deleted property slug (object)

  URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.

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

Return Type:

• Renamed property _id to id (object)

  Unique identifier for the Item

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property created-on to CreatedOn

  The date the item was created

• Renamed property updated-on to lastUpdated

  The date the item was last updated

• Renamed property published-on to lastPublished

  The date the item was last published

• Added property fieldData (object)

• Deleted property items (object)

  List of Items within the collection

• Deleted property count (object)

  Number of items returned

• Deleted property limit (object)

  The limit specified in the request

• Deleted property offset (object)

  The offset specified for pagination

• Deleted property total (object)

  Total number of items in the collection

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

Delete Collection Item

Parameters:

Deleted: live in query

Boolean indicating if the item(s) should be published/unpublished to/from the live site

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

Update Collection Item

Parameters:

Deleted: live in query

Boolean indicating if the item(s) should be published/unpublished to/from the live site

Request:

Details of the item to update

• Added property isArchived (object)

  Boolean determining if the Item is set to archived

• Added property isDraft (object)

  Boolean determining if the Item is set to draft

• Added property fieldData (object)

• Deleted property fields (object)

  Fields in your collection item

Return Type:

• Renamed property _id to id (object)

  Unique identifier for the Item

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property created-on to CreatedOn

  The date the item was created

• Renamed property updated-on to lastUpdated

  The date the item was last updated

• Renamed property published-on to lastPublished

  The date the item was last published

• Added property fieldData (object)

• Deleted property _cid (object)

  Unique identifier for the Collection the Item belongs within

• Deleted property name (object)

  Name given to the Item

• Deleted property slug (object)

  URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.

User Accounts

GET /sites/{site_id}/users

In addition to individual property changes listed below, this API also replaces /sites/{site_id}/accessgroups

Return Type:

• Renamed property _id to id

  Unique identifier for the User

• Renamed property updatedOn to lastUpdated

  The date the item was last updated

• Renamed property emailVerified to isEmailVerified

  Shows whether the user has verified their email address

• Added property accessGroups

GET /sites/{site_id}/users/{user_id}

Return Type:

• Renamed property _id to id

  Unique identifier for the User

• Renamed property updatedOn to lastUpdated

  The date the item was last updated

• Renamed property emailVerified to isEmailVerified

  Shows whether the user has verified their email address

PATCH /sites/{site_id}/users/{user_id}

Request:

• Added property data (object)

  • Property name (object)

    The name of the user

  • Property accept-privacy (object)

    Boolean indicating if the user has accepted the privacy policy

  • Property accept-communications (object)

    Boolean indicating if the user has accepted to receive communications

• Added property accessGroups (object)

  An array of access group slugs. Access groups are assigned to the user as type admin and the user remains in the group until removed.

Return Type:

• Renamed property _id to id

  Unique identifier for the User

• Renamed property updatedOn to lastUpdated

  The date the item was last updated

• Renamed property emailVerified to isEmailVerified

  Shows whether the user has verified their email address

POST /sites/{site_id}/users/invite

Return Type:

• Renamed property _id to id

  Unique identifier for the User

• Renamed property updatedOn to lastUpdated

  The date the item was last updated

• Renamed property emailVerified to isEmailVerified

  Shows whether the user has verified their email address

GET /sites/{site_id}/products

Return Type:

• Added property pagination (object) to replace pagination properties

  Pagination object

  • Property limit (object)

    The limit used for pagination

  • Property offset (object)

    The offset used for pagination

  • Property total (object)

    The total number of records

• Deleted property count (object)

  Number of items returned

• Changed property items (object)

  List of Item objects within the Collection. Contains product and skus keys for each Item

  • Renamed property _id to id

    Unique identifier for the Product

  • Added property lastPublished

    The date the Product was last published

Ecommerce

Products

POST /sites/{site_id}/products

Request:

New required properties:

• product

• sku

• Added property publishStatus (object)

  Publish target

  Enum values:

  • staging
  • live

• Changed property product (object)

  The Product object

  • Renamed property _id to id

    Unique identifier for the Product

  • Added property isArchived (object)

    Boolean determining if the Product is set to archived

  • Added property isDraft (object)

    Boolean determining if the Product is set to draft

  • Added property fieldData (object)

    • Property name (object)

      Name of the Product

    • Property slug (object)

      URL structure of the Product in your site.

    • Property sku-properties (object)

      Variant/Options types to include in SKUs

  • Deleted property fields (object)

    Fields in your product object

• Changed property sku (object)

  The SKU object

  New optional properties:

  • _id

  • fields

  • name

  • slug

  • Added property fieldData (object)

    • Property name (object)

      Name of the Product

    • Property slug (object)

      URL structure of the Product in your site.

    • Property price (object)

      price of SKU

      • Property value (object)

        Price of SKU

      • Property unit (object)

        Currency of Item

    • Property sku-values (object)

      A dictionary that maps a SKU property to a SKU value. The key of the dictionary is the SKU property ID, and the value is the SKU value ID.

  • Deleted property fields (object)

    Fields in your SKU object

Return Type:

• Renamed property sku to skus (object)

  The SKU object

• Changed property product (object)

  The Product object

  • Renamed property _id to id

    Unique identifier for the Product

  • Renamed property _archived to isArchived

    Boolean determining if the Item is set to archived

  • Renamed property _draft to isDraft

    Boolean determining if the Item is set to draft

  • Renamed property created-on to CreatedOn

    The date the item was created

  • Renamed property updated-on to lastUpdated

    The date the item was last updated

  • Renamed property published-on to lastPublished

    The date the item was last published

  • Renamed property fields to fieldData(object)

    Fields in your product object

  • Deleted property slug (object)

    Slug of Collection in Site URL structure

  • Deleted property singularName (object)

    The name of one Item in Collection (e.g. “product” if the Collection is called “Product”)

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

Return Type:

• Added property product (object)

  The Product object

  • Renamed property _id to id

    Unique identifier for the Product

  • Renamed property _archived to isArchived

    Boolean determining if the Item is set to archived

  • Renamed property _draft to isDraft

    Boolean determining if the Item is set to draft

  • Renamed property created-on to CreatedOn

    The date the item was created

  • Renamed property updated-on to lastUpdated

    The date the item was last updated

  • Renamed property published-on to lastPublished

    The date the item was last published

  • Moved property sku-properties as a child object of fieldData (object)

• Added property skus (object)

• Deleted property items (object)

  List of SKUs for a Product

• Deleted property count (object)

  Number of items returned

• Deleted property limit (object)

  The limit specified in the request

• Deleted property offset (object)

  The offset specified for pagination

• Deleted property total (object)

  Total number of items in the collection

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

Request:

New required properties:

• product
• Added property publishStatus (object)

  Publish target

• Added property product (object)

  The Product object

• Deleted property fields (object)

  Fields in your collection item

Return Type:

• Added property fieldData (object)

• Renamed property _id to id

  Unique identifier for the Product

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property published-on to lastPublished

  The date the item was last published

• Deleted property name (object)

  Name given to Collection

• Deleted property slug (object)

  Slug of Collection in Site URL structure

• Deleted property singularName (object)

  The name of one Item in Collection (e.g. “product” if the Collection is called “Product”)

• Deleted property fields (object)

  Fields in your product object

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

Request:

New required properties(previously not marked as required):

• skus
• Added property publishStatus (object)

  Publish target

Return Type:

• Added property fieldData (object)

• Renamed property _id to id

  Unique identifier for the Product

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property published-on to lastPublished

  The date the item was last published

• Deleted property name (object)

  Name given to Collection

• Deleted property slug (object)

  Slug of Collection in Site URL structure

• Deleted property singularName (object)

  The name of one Item in Collection (e.g. “product” if the Collection is called “Product”)

• Deleted property fields (object)

  Fields in your product object

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

Request:

New required properties:

• sku

• Added property publishStatus (object)

  Publish target

• Changed property sku (object)

  The SKU object

  New optional properties:

  • _id
  • fields
  • name
  • slug
  • Added property fieldData (object)
  • Deleted property fields (object)

    Fields in your SKU object

Return Type:

• Renamed property _id to id

  Unique identifier for the Product

• Renamed property _archived to isArchived

  Boolean determining if the Item is set to archived

• Renamed property _draft to isDraft

  Boolean determining if the Item is set to draft

• Renamed property published-on to lastPublished

  The date the item was last published

• Added property fieldData (object)

• Deleted property name (object)

  Name given to Collection

• Deleted property slug (object)

  Slug of Collection in Site URL structure

• Deleted property singularName (object)

  The name of one Item in Collection (e.g. “sku” if the Collection is called “SKU”)

• Deleted property fields (object)

  Fields in your SKU object

Orders

GET /sites/{site_id}/orders

Return Type:

• Added property items (object)

  List of orders

• Added property pagination (object)

  Pagination object

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

Get Order, replaces GET /sites/{site_id}/order/{order_id}

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

Update Order, replaces PATCH /sites/{site_id}/order/{order_id}

GET /sites/{site_id}/custom_domains

Get Custom Domains, replaces /sites/{site_id}/domains

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

Fulfill Order, replaces POST /sites/{site_id}/order/{order_id}/fulfill

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

Unfulfill Order, replaces POST /sites/{site_id}/order/{order_id}/unfulfill

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

Refund Order, replaces POST /sites/{site_id}/order/{order_id}/refund

Inventory

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

Return Type:

• Renamed property _id to id

  Unique identifier for the Product

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

Request:

New required properties:

• inventoryType

• Added property inventoryType (object)

  infinite or finite

  Enum values:

  • infinite
  • finite

• Added property updateQuantity (object)

  Adds this quantity to currently store quantity. Can be negative.

• Added property quantity (object)

  Immediately sets quantity to this value.

• Deleted property fields (object)

  The inventory fields to update

Return Type:

• Renamed property _id to id

  Unique identifier for the Product

GET /sites/{site_id}/ecommerce/settings

Return Type:

• Renamed property site to siteId (object)

  The identifier of the Site

Webhooks

GET /webhooks/{webhook_id}

Get Webhook, replaces v1 GET /sites/{site_id}/webhooks/{webhook_id}

GET /sites/{site_id}/webhooks

Return Type:

• Added property webhooks, all webhooks are in an array in this object

  • Renamed property _id to id (object)

    The identifier of the Webhook

  • Renamed property site to siteId (object)

    The identifier of the Site

  • Added property workspaceId

    Identifier of the workspace

  • Deleted property triggerId

  • Renamed property lastUsed to lastTriggered

    Date the Webhook instance was last triggered

  • Added property url

    URL to send the Webhook payload to

POST /sites/{site_id}/webhooks

Request:

• Changed property triggerType (object)

  • form_submission - Sends the form_submission event
  • site_publish - Sends a site_publish event
  • page_created - Send the page_created event
  • page_metadata_updated - Sends the page_metadata_updated event
  • page_deleted - Sends the page_deleted event
  • ecomm_new_order - Sends the new ecomm_new_order event
  • ecomm_order_changed - Sends the ecomm_order_changed event
  • ecomm_inventory_changed - Sends the ecomm_inventory_changed event
  • user_account_added - Sends the user_account_added event
  • user_account_updated - Sends the user_account_updated event
  • user_account_deleted - Sends the user_account_deleted event
  • collection_item_created - Sends the collection_item_created event
  • collection_item_changed - Sends the collection_item_changed event
  • collection_item_deleted - Sends the collection_item_deleted event
  • collection_item_unpublished - Sends the collection_item_unpublished event

  Added enum values:

  • page_created

  • page_metadata_updated

  • page_deleted

  • user_account_added

  • user_account_updated

  • user_account_deleted
    Removed enum values:

  • memberships_user_account_added

  • memberships_user_account_updated

  • memberships_user_account_deleted

• Changed property filter (object)

  filter for selecting which events you want webhooks to be triggered for.
  Only available for form_submission trigger types.

Return Type:

• Renamed property _id to id (object)

  The identifier of the Webhook

• Renamed property site to siteId (object)

  The identifier of the Site

• Added property workspaceId

  Identifier of the workspace

• Deleted property triggerId

• Renamed property lastUsed to lastTriggered

  Date the Webhook instance was last triggered

• Added property url

  URL to send the Webhook payload to

• Added property filter

  Filter for selecting which events you want Webhooks to be sent for. Only supported for form_submission trigger types.

DELETE /webhooks/{webhook_id}

Remove Webhook, replaces DELETE v1 /sites/{site_id}/webhooks/{webhook_id}