Skip to navigation
Sitemap IndexingPages

List Page Sitemap Settings

Lists the sitemap setting of each static page on a site, newest page first. The list leaves out folders, utility pages, and collection template pages, because they don’t support sitemap indexing. It also leaves out archived pages.

For a secondary locale, a page with no setting of its own returns the primary locale’s 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 | pages:read

Authentication

AuthorizationBearer

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

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site

Query parameters

localeIdstringOptional

Unique identifier for a specific Locale.

Learn more about localization.

limitintegerOptional

Maximum number of records to be returned (max limit: 100)

offsetintegerOptional
Offset used for pagination if the results have more than limit records

Response

Request was successful
pageslist of objects
The listed pages.
paginationobject
Pagination object

Errors

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