Get Lightning Page Actions | User Interface API Developer Guide

1/ui-api/actions/flexipage/${flexipageNames}

flexipageNames—A Lightning page name, or a comma-delimited list of Lightning page names.

41.0

GET

As an example, let’s say we have a Lightning page named MyNewLightningPage. The page has quick actions for logging a call and creating an account. To get information about all the actions on this page, make this request:

1GET /services/data/v61.0/ui-api/actions/flexipage/MyNewLightningPage

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

1{
2  "actions" : {
3    "MyNewLightningPage" : {
4      "actions" : [ {
5        "actionListContext" : "Flexipage",
6        "actionTarget" : "/services/data/v41.0/quickActions/LogACall/describe",
7        "actionTargetType" : "Describe",
8        "apiName" : "LogACall",
9        "externalId" : "00DR00000008n7M:MyNewLightningPage::Flexipage:Desktop:09DR00000000Snt",
10        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/log_a_call_120.png",
11        "id" : "0JVR00000000009OAA",
12        "isMassAction" : "false",
13        "label" : "Log a Call",
14        "primaryColor" : "48C3CC",
15        "relatedListRecordId" : null,
16        "relatedSourceObject" : null,
17        "section" : null,
18        "sourceObject" : "MyNewLightningPage",
19        "subtype" : "LogACall",
20        "targetObject" : "Task",
21        "targetUrl" : null,
22        "type" : "QuickAction"
23      }, {
24        "actionListContext" : "Flexipage",
25        "actionTarget" : "/services/data/v41.0/quickActions/NewAccount/describe",
26        "actionTargetType" : "Describe",
27        "apiName" : "NewAccount",
28        "externalId" : "00DR00000008n7M:MyNewLightningPage::Flexipage:Desktop:09DR00000000Sni",
29        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new_account_120.png",
30        "id" : "0JVR00000000010OAA",
31        "isMassAction" : "false",
32        "label" : "New Account",
33        "primaryColor" : "7F8DE1",
34        "relatedListRecordId" : null,
35        "relatedSourceObject" : null,
36        "section" : null,
37        "sourceObject" : "MyNewLightningPage",
38        "subtype" : "Create",
39        "targetObject" : "Account",
40        "targetUrl" : null,
41        "type" : "QuickAction"
42      } ],
43      "links" : [ ],
44      "url" : "/services/data/v41.0/ui-api/actions/flexipage/MyNewLightningPage"
45    }
46  },
47  "url" : "/services/data/v41.0/ui-api/actions/flexipage/MyNewLightningPage"
48}

Parameter Name	Type	Description	Required or Optional	Available Version
`actionTypes`	String[]	The action type. One or more 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
`apiNames`	String[]	The API names of one or more actions to be retrieved. Use this parameter only when passing `retrievalMode=All`.	Optional	49.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
`retrievalMode`	String	When the action context is `Record`, this parameter indicates which actions to retrieve from the record page. One of these values: `All`—Retrieves all actions specified in the `apiNames` parameter. `PageLayout`—(Default) Retrieves actions from the page layout.	Optional	49.0
`sections`	String[]	The section of the user interface that the actions reside in. One or more of these values: `ActivityComposer` `CollaborateComposer` `Page` `SingleActionLinks`	Optional	41.0

Action