Open topic with navigation

User Navigation Links REST API

Overview

The User Navigation Links REST API retrieves the user navigation links defined in the Navigation Menu for a site.

Administration

Get All User Navigation Links

Get All User Navigation Links
Description	This endpoint retrieves the global branding properties defined for a site.
URI Endpoint	/rest/v17/userNavigationLinks
Endpoint Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. excludeLinks - Exclude links from the response. fields - A list of fields to be returned. The value is a comma delimited string and each token is a field name. limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum. offset – The offset of the page. By default, offset is 0, which means first page will be returned. orderby – Specifies a comma-separated list of fields to order the response by. totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	navigationType	The string value of Navigation type. Allowed values are: `ALTA_NAVIGATION`, `TOP_NAVIGATION`, or `SIDE_NAVIGATION`
	siteUrl	The base URI for the site to be used with the URLs to fully define the links
	offset	The integer offset value used in the current page
	count	Total number of records returned in the response
	label	Label of the navigation link as defined
	url	Relative path of the link as defined
	linkType	Navigation link type. Possible values are `TAB` or `LINK`
	displayType	Display type of the navigation link. Possible values are `LABEL`, `ICON`, or `BOTH`
	group	Group of the navigation link. Possbile values are `ADMIN`, `SUBHEADER`, `SUBFOOTER`, `COMMERCE`, or `QUICK_REGISTRATION`
	subgroup	Sub group of the navigation link. Possible values are `LEFT`, `RIGHT`, or `CENTER`
	iconPath	Path of the navigation link image file
	iconPosition	Position of the icon to be displayed with respect to label. Possible values are `LEFT_OF_LABEL`, or `RIGHT_OF_LABEL`
	order	Sequence number within the group and subgroup
	isInternal	Is the navigation menu link system defined? Yes = true No = false

URI Endpoint Sample

Sample Response Body

Related Topics