Get Lookup Field Actions

Get the actions on lookup fields.

Resource

1/ui-api/actions/lookup/${objectApiNames}

objectApiNames—A lookup field name, or a comma-delimited list of lookup field names.

Available Version

41.0

HTTP Method

GET

Example

As an example, let’s say we have a lookup field on a New Account dialog box. To get information about the actions on this lookup field, make this request:

1GET /services/data/v63.0/ui-api/actions/lookup/Account

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

1{
2  "actions" : {
3    "Account" : {
4      "actions" : [ {
5        "actionListContext" : "Lookup",
6        "actionTarget" : null,
7        "actionTargetType" : "Invoke",
8        "apiName" : "CreateFromLookup",
9        "externalId" : "00DR00000008n7M:Account::Lookup:Phone:StandardButton:CreateFromLookup",
10        "iconUrl" : "https://yourInstance.salesforce.com/img/icon/t4v35/action/new_120.png",
11        "id" : "0JVR00000000004OAA",
12        "isMassAction" : "false",
13        "label" : "New",
14        "primaryColor" : "33BCE7",
15        "relatedListRecordId" : null,
16        "relatedSourceObject" : null,
17        "section" : "Page",
18        "sourceObject" : "Account",
19        "subtype" : null,
20        "targetObject" : "Account",
21        "targetUrl" : null,
22        "type" : "StandardButton"
23      } ],
24      "links" : [ ],
25      "url" : "/services/data/v41.0/ui-api/actions/lookup/Account"
26    }
27  },
28  "url" : "/services/data/v41.0/ui-api/actions/lookup/Account"
29}

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 Lookup Field Actions

See Also