Navigation Menu Items

Get navigation menu items for an Experience Cloud site.

Supported navigation menu item types are:

Event—Event, such as logging in, logging out, or switching accounts.
ExternalLink—URL outside of your site.
GlobalAction—Lets users create records that aren’t related to other records.
InternalLink—Relative URL inside your site.
MenuLabel—Menu label.
NavigationalTopic—Dropdown list with links to the navigational topics in your site.
SalesforceObject—Objects such as accounts, cases, contacts, and custom objects.
SystemLink—System link, such as a link to Builder, Workspaces, or Setup.

Resource

1/connect/communities/communityId/navigation-menu/navigation-menu-items

Available version

47.0

Requires Chatter

HTTP methods

GET

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`addHomeMenuItem`	Boolean	Specifies whether to add the Home menu item (`true`) or not (`false`).	Optional	47.0
`effectiveAccountId`	String	ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user.	Optional	54.0
`includeImageUrl`	Boolean	Specifies whether to include the image URL with the menu item (`true`) or not (`false`). Data Source menu item types with a Storefront Categories data source aren’t supported when `includeImageUrl` is `true`.	Optional	47.0
`menuItemTypesToSkip`	String[]	List of menu item types to filter out of the results. Values are: `Event`—Event, such as logging in, logging out, or switching accounts. `ExternalLink`—URL outside of your site. `GlobalAction`—Lets users create records that aren’t related to other records. `InternalLink`—Relative URL inside your site. `MenuLabel`—Menu label. `NavigationalTopic`—Dropdown list with links to the navigational topics in your site. `SalesforceObject`—Objects such as accounts, cases, contacts, and custom objects. `SystemLink`—System link, such as a link to Builder, Workspaces, or Setup.	Optional	47.0
`navigationLinkSetDeveloperName`	String	Developer name of the navigation link set. Provide either `navigationLinkSetIdDeveloperName` or `navigationLinkSetId`.	Optional	49.0
`navigationLinkSetId`	String	ID of the navigation link set.	Optional	47.0
`publishStatus`	String	Publish status of the navigation menu item. Values are: `Draft` `Live`	Optional	47.0

Response body for GET

Navigation Menu Item Collection

Connect REST API Developer Guide

Navigation Menu Items