Get a Site Map by ID

GET /content/api/v2/site-maps/:site_map_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get a specific site map by its ID.
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.
site_map_id Used in the request URL Unique identifier for a particular site map

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