Skip to navigation

Get Item Sitemap Setting

Returns the sitemap setting of one item, from the staged version of the item. The staged version includes changes that aren’t published yet. To read the setting on the live site, use Get Live Item Sitemap Setting.

Beta access
These endpoints are available only to workspaces in the sitemap indexing beta. Valid requests from other workspaces return 404.
Enterprise Only
This endpoint requires an Enterprise workspace.

Required scope | cms:read

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequiredformat: "objectid"
Unique identifier for a Collection
item_idstringRequiredformat: "objectid"
Unique identifier for an Item

Query parameters

cmsLocaleIdstringOptional

Unique identifier for a CMS locale. This ID is different from the site locale ID and is listed as cmsLocaleId in the Sites response. Omit it to read the item in the site’s primary locale.

Response

Request was successful
idstringformat: "objectid"
Unique identifier for the item
slugstring
The item's slug
namestring
The item's name
includeInSitemapboolean

Whether Webflow lists the item’s page in the site’s auto-generated sitemap.xml file. Archived items, and draft items that were never published, are left out whatever this value is. This setting has no effect when Auto-generate sitemap is turned off.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error