Work with Actions

Use the Actions resources to get data and metadata about actions displayed in the Salesforce UI. Examples include standard and custom buttons, quick actions, and productivity actions.

Get Actions for a Record Detail Page

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

1GET /services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG

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

1{
2	"actions": {
3		"001R0000003IDlwIAG": {
4			"actions": [{
5				"actionListContext": "Record",
6				"actionTarget": null,
7				"actionTargetType": "Invoke",
8				"apiName": "Edit",
9				"externalId": "00DR00000008n7M:001R0000003IDlwIAG::Record:Phone:StandardButton:Edit",
10				"iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/action/edit_120.png",
11				"id": "0JVR00000000017OAA",
12				"isMassAction": "false",
13				"label": "Edit",
14				"primaryColor": "1DCCBF",
15				"relatedListRecordId": null,
16				"relatedSourceObject": null,
17				"section": "Page",
18				"sourceObject": "001R0000003IDlwIAG",
19				"subtype": null,
20				"targetObject": "Account",
21				"targetUrl": null,
22				"type": "StandardButton"
23				},
24				{
25				"actionListContext" : "Record",
26				"actionTarget" : "/services/data/v41.0/quickActions/NewTask/describe",
27				"actionTargetType" : "Describe",
28				"apiName" : "NewTask",
29				"externalId" : "00DR00000008n7M:001R0000003IDlwIAG::Record:Phone:09DR00000000Sns",
30				"iconUrl" : "https:/yourInstance.salesforce.com/img/icon/t4v35/action/new_task_120.png",
31				"id" : "0JVR00000000014OAA",
32				"isMassAction" : "false",
33				"label" : "New Task",
34				"primaryColor" : "4BC076",
35				"relatedListRecordId" : null,
36				"relatedSourceObject" : null,
37				"section" : "ActivityComposer",
38				"sourceObject" : "001R0000003IDlwIAG",
39				"subtype" : "Create",
40				"targetObject" : "Task",
41				"targetUrl" : null,
42				"type" : "QuickAction"
43				}
44				
45... Additional actions removed for brevity ...
46
47			],
48			"links": ["/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/record-edit", 
49"/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG/related-list", "/services/data/v41.0/ui-
50api/actions/record/001R0000003IDlwIAG/related-list-record/${relatedRecordId}"],
51			"url": "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG"
52		}
53	},
54	"url": "/services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG"
55}

Filter the Action Results

To filter the results returned by the Actions resources, use the following request parameters:

actionTypes—The action type.
formFactor—The layout display size.
sections—The section of the user interface that the action resides in.

For example, to filter a record actions request so that it includes only standard button actions, set the actionTypes parameter to StandardButton.

1GET /services/data/v41.0/ui-api/actions/record/001R0000003IDlwIAG?actionTypes=StandardButton

User Interface API Developer Guide

Work with Actions