Data API ToolsCMS

Items

Create, update, and manage CMS collection items using the Items tools. Items are the actual content entries in your collections.

List items

List items in a CMS collection with optional filtering and sorting.

Tool: collections_items_list_items

collection_id
stringRequired

Unique identifier for the collection

cmsLocaleId
string

Unique identifier for the locale

limit
number

Maximum number of records to return (max: 100)

offset
number

Offset for pagination

name
string

Filter by item name

slug
string

Filter by item slug

sortBy
string

Field to sort by

sortOrder
string

Sort order (asc/desc)

Returns A list of items in the collection.

Response
1{
2  "items": [
3    {
4      "id": "62b720ef280c7a7a3be8cabe",
5      "lastPublished": "2022-06-30T13:35:20.878Z",
6      "lastUpdated": "2022-06-25T14:51:27.809Z",
7      "createdOn": "2022-06-25T14:51:27.809Z",
8      "fieldData": {
9        "name": "Senior Data Analyst",
10        "slug": "senior-data-analyst",
11        "url": "https://boards.greenhouse.io/webflow/jobs/26567701",
12        "department": "Data"
13      },
14      "cmsLocaleId": "66f6e966c9e1dc700a857ca3",
15      "isArchived": false,
16      "isDraft": false
17    },
18    {
19      "id": "62c880ef281c7b7b4cf9dabc",
20      "lastPublished": "2023-04-15T10:25:18.123Z",
21      "lastUpdated": "2023-04-10T11:45:30.567Z",
22      "createdOn": "2023-04-10T11:45:30.567Z",
23      "fieldData": {
24        "name": "Product Manager",
25        "slug": "product-manager",
26        "url": "https://boards.greenhouse.io/webflow/jobs/31234567",
27        "department": "Product"
28      },
29      "cmsLocaleId": "66f6e966c9e1dc700a857ca3",
30      "isArchived": false,
31      "isDraft": false
32    }
33  ],
34  "pagination": {
35    "limit": 25,
36    "offset": 0,
37    "total": 2
38  }
39}

Create item (draft)

Create new items in a CMS collection as drafts.

Tool: collections_items_create_item

collection_id
stringRequired

Unique identifier for the collection

request
objectRequired

Item creation request with field values

POST
/v2/collections/:collection_id/items
1from webflow import (
2    CollectionItemPostSingle,
3    CollectionItemPostSingleFieldData,
4    Webflow,
5)
6
7client = Webflow(
8    access_token="YOUR_ACCESS_TOKEN",
9)
10client.collections.items.create_item(
11    collection_id="580e63fc8c9a982ac9b8b745",
12    skip_invalid_files=True,
13    request=CollectionItemPostSingle(
14        is_archived=False,
15        is_draft=False,
16        field_data=CollectionItemPostSingleFieldData(
17            name="The Hitchhiker's Guide to the Galaxy",
18            slug="hitchhikers-guide-to-the-galaxy",
19        ),
20    ),
21)

Returns: Created item object with ID

Items created with this tool are saved as drafts and must be published.
This tool does not create localized items

This tool does not create localized items.

Create item (live)

Create and publish new items in a CMS collection directly to the live site.

Tool: collections_items_create_item_live

collection_id
stringRequired

Unique identifier for the collection

request
objectRequired

Item creation request with field values

POST
/v2/collections/:collection_id/items/live
1from webflow import CollectionItem, CollectionItemFieldData, Webflow
2
3client = Webflow(
4    access_token="YOUR_ACCESS_TOKEN",
5)
6client.collections.items.create_item_live(
7    collection_id="580e63fc8c9a982ac9b8b745",
8    skip_invalid_files=True,
9    request=CollectionItem(
10        is_archived=False,
11        is_draft=False,
12        field_data=CollectionItemFieldData(
13            name="The Hitchhiker's Guide to the Galaxy",
14            slug="hitchhikers-guide-to-the-galaxy",
15        ),
16    ),
17)

Returns: Created and published item object

Items created with this tool are immediately published to the live site.

Update items (draft)

Update existing items in a CMS collection as drafts.

Tool: collections_items_update_items

collection_id
stringRequired

Unique identifier for the collection

request
objectRequired

Item update request with item IDs and field updates

PATCH
/v2/collections/:collection_id/items
1from webflow import (
2    CollectionItemWithIdInput,
3    CollectionItemWithIdInputFieldData,
4    Webflow,
5)
6
7client = Webflow(
8    access_token="YOUR_ACCESS_TOKEN",
9)
10client.collections.items.update_items(
11    collection_id="580e63fc8c9a982ac9b8b745",
12    skip_invalid_files=True,
13    items=[
14        CollectionItemWithIdInput(
15            id="66f6ed9576ddacf3149d5ea6",
16            cms_locale_id="66f6e966c9e1dc700a857ca5",
17            field_data=CollectionItemWithIdInputFieldData(
18                name="Ne Paniquez Pas",
19                slug="ne-paniquez-pas",
20            ),
21        ),
22        CollectionItemWithIdInput(
23            id="66f6ed9576ddacf3149d5ea6",
24            cms_locale_id="66f6e966c9e1dc700a857ca4",
25            field_data=CollectionItemWithIdInputFieldData(
26                name="No Entrar en Pánico",
27                slug="no-entrar-en-panico",
28            ),
29        ),
30        CollectionItemWithIdInput(
31            id="66f6ed9576ddacf3149d5eaa",
32            cms_locale_id="66f6e966c9e1dc700a857ca5",
33            field_data=CollectionItemWithIdInputFieldData(
34                name="Au Revoir et Merci pour Tous les Poissons",
35                slug="au-revoir-et-merci",
36            ),
37        ),
38        CollectionItemWithIdInput(
39            id="66f6ed9576ddacf3149d5eaa",
40            cms_locale_id="66f6e966c9e1dc700a857ca4",
41            field_data=CollectionItemWithIdInputFieldData(
42                name="Hasta Luego y Gracias por Todo el Pescado",
43                slug="hasta-luego-y-gracias",
44            ),
45        ),
46    ],
47)

Returns: Updated item objects

Update items (live)

Update and publish existing items in a CMS collection directly to the live site.

Tool: collections_items_update_items_live

collection_id
stringRequired

Unique identifier for the collection

request
objectRequired

Item update request with item IDs and field updates

PATCH
/v2/collections/:collection_id/items/live
1from webflow import (
2    CollectionItemWithIdInput,
3    CollectionItemWithIdInputFieldData,
4    Webflow,
5)
6
7client = Webflow(
8    access_token="YOUR_ACCESS_TOKEN",
9)
10client.collections.items.update_items_live(
11    collection_id="580e63fc8c9a982ac9b8b745",
12    skip_invalid_files=True,
13    items=[
14        CollectionItemWithIdInput(
15            id="66f6ed9576ddacf3149d5ea6",
16            cms_locale_id="66f6e966c9e1dc700a857ca5",
17            field_data=CollectionItemWithIdInputFieldData(
18                name="Ne Paniquez Pas",
19                slug="ne-paniquez-pas",
20            ),
21        ),
22        CollectionItemWithIdInput(
23            id="66f6ed9576ddacf3149d5ea6",
24            cms_locale_id="66f6e966c9e1dc700a857ca4",
25            field_data=CollectionItemWithIdInputFieldData(
26                name="No Entrar en Pánico",
27                slug="no-entrar-en-panico",
28            ),
29        ),
30        CollectionItemWithIdInput(
31            id="66f6ed9576ddacf3149d5eaa",
32            cms_locale_id="66f6e966c9e1dc700a857ca5",
33            field_data=CollectionItemWithIdInputFieldData(
34                name="Au Revoir et Merci pour Tous les Poissons",
35                slug="au-revoir-et-merci",
36            ),
37        ),
38        CollectionItemWithIdInput(
39            id="66f6ed9576ddacf3149d5eaa",
40            cms_locale_id="66f6e966c9e1dc700a857ca4",
41            field_data=CollectionItemWithIdInputFieldData(
42                name="Hasta Luego y Gracias por Todo el Pescado",
43                slug="hasta-luego-y-gracias",
44            ),
45        ),
46    ],
47)

Returns: Updated and published item objects

Publish items

Publish draft items in a CMS collection to make them live.

Tool: collections_items_publish_items

collection_id
stringRequired

Unique identifier for the collection

itemIds
arrayRequired

Array of item IDs to be published

POST
/v2/collections/:collection_id/items/publish
1from webflow import Webflow
2from webflow.resources.collections.resources.items import ItemIDs
3
4client = Webflow(
5    access_token="YOUR_ACCESS_TOKEN",
6)
7client.collections.items.publish_item(
8    collection_id="580e63fc8c9a982ac9b8b745",
9    request=ItemIDs(
10        item_ids=[
11            "643fd856d66b6528195ee2ca",
12            "643fd856d66b6528195ee2cb",
13            "643fd856d66b6528195ee2cc",
14        ],
15    ),
16)

Returns: Publishing confirmation

Delete item

Delete an item in a CMS collection. Items will only be deleted in the primary locale unless a cmsLocaleId is included in the request.

Tool: collections_items_delete_item

collection_id
stringRequired

Unique identifier for the collection

itemId
stringRequired

Item ID to be deleted

cmsLocaleIds
string

Unique identifier for the locale

DELETE
/v2/collections/:collection_id/items/:item_id
1from webflow import Webflow
2
3client = Webflow(
4    access_token="YOUR_ACCESS_TOKEN",
5)
6client.collections.items.delete_item(
7    collection_id="580e63fc8c9a982ac9b8b745",
8    item_id="580e64008c9a982ac9b8b754",
9    cms_locale_id="cmsLocaleId",
10)

Returns: Deletion confirmation