List Site Maps

GET /content/api/v2/site-maps

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get all site maps. Supports paging and filtering.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Optional query string filters & options

If a parameter supports a filter type of 'gt', that means you can append a double underscore to the parameter name to find all items greater than the value. For example, the following query will find all items created than the 'updated' time:
Parameter name Description
limit The number of items to return. Defaults to 20
offset The offset set to start returning rows from. Defaults to 0.
deleted_at exact, gt, lt
id exact
name exact

JSON Fields returned in the response

Parameter name Type Description
created long When the site map was first created, in milliseconds since the epoch
deleted_at long When the site map was deleted, in milliseconds since the epoch. Zero if the site map was never deleted. Use a DELETE request to site map the page, do not set this directly.
id string The unique id of the site map
name string The internal name of the site map
pages_tree string The full JSON data for the tree structure
updated long When the site map was last updated, in milliseconds since the epoch