Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get Global Actions

Get the actions in the Global Actions menu.

Resource

1/ui-api/actions/global

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a New Opportunity global action, among other actions. To get information about global actions, make this request:

1GET /services/data/v67.0/ui-api/actions/global

The request returns a list of global actions, including New Opportunity, and the URLs of the request and subrequests.

1{
2  "actions" : {
3    "001R0000003IDlwIAG" : {
4        "actionListContext" : "Global",
5        "actionTarget" : "/services/data/v41.0/quickActions/NewOpportunity/describe",
6        "actionTargetType" : "Describe",
7        "apiName" : "NewOpportunity",
8        "externalId" : "00DR00000008n7M:Global::Global:Phone:09DR00000000Snl",
9        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new_opportunity_120.png",
10        "id" : "0JVR00000000030OAA",
11        "isMassAction" : "false",
12        "label" : "New Opportunity",
13        "primaryColor" : "FCB95B",
14        "relatedListRecordId" : null,
15        "relatedSourceObject" : null,
16        "section" : "Page",
17        "sourceObject" : "Global",
18        "subtype" : "Create",
19        "targetObject" : "Opportunity",
20        "targetUrl" : null,
21        "type" : "QuickAction"
22      }
23
24... Additional actions removed for brevity ...
25
26],
27      "links" : [ ],
28      "url" : "/services/data/v41.0/ui-api/actions/global"
29    }
30  },
31  "url" : "/services/data/v41.0/ui-api/actions/global"
32}

Request Parameters

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

Response Body

Action

User Interface API Developer Guide

Get Global Actions