Get Related List Actions

Get the actions on related lists on a record detail page.

Resources

relatedListIds—A related list ID, or a comma-delimited list of related list IDs.

${relatedListId} is optional. The request returns all related list actions when ${relatedListIds} isn’t supplied.

Note

Available version

41.0

HTTP methods

GET

Example

As an example, let’s say we have an Account record detail page with a record ID of 001R0000003IDlwIAG. The page has some related lists, including tasks and events. To get information about all the related list actions on this page, make this request:

The request returns a list of related list actions on the page and the URLs of the request and subrequests.

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`actionTypes`	String[]	The action type. One of these values: `CustomButton`—A button that opens a URL or Visualforce page or executes JavaScript. `ProductivityAction`—A pre-defined Salesforce action, attached to a limited set of objects. `QuickAction`—A global or object-specific action. `StandardButton`—A pre-defined Salesforce button, such as New, Edit, and Delete.	Optional	41.0
`formFactor`	String	The layout display size. One of these values: `Large`—(Default) Use this value to get a layout for desktop display size. `Medium`—Use this value to get a layout for tablet display size. `Small`—Use this value to get a layout for phone display size.	Optional	41.0
`sections`	String[]	The section of the user interface that the action resides in. One of these values: `ActivityComposer` `CollaborateComposer` `Page` `SingleActionLinks`	Optional	41.0

Response body for GET

ActionRepresentation

User Interface API Developer Guide

Get Related List Actions