Get Related List Actions
GET {{_endpoint}}/services/data/v{{version}}/ui-api/actions/record/:RECORD_ID/related-list/:RELATED_LIST_IDS
Get the actions on record detail pages.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
actionTypes | null | The action type (CustomButton, ProductivityAction, QuickAction or StandardButton) | |
apiNames | null | The API names of one or more actions to be retrieved. Use this parameter only when passing retrievalMode=All. | |
formFactor | null | The layout display size (Large (default), Medium or Small). | |
retrievalMode | null | When the action context is Record, this parameter indicates which actions to retrieve from the record page. Either All or PageLayout (default). | |
sections | null | The section of the user interface that the actions reside in (ActivityComposer, CollaborateComposer, Page or SingleActionLinks). |
RESPONSES
status: OK
{"actions":{"00158000006QBOhAAO":{"actions":[{"actionListContext":"RelatedList","actionTarget":null,"actionTargetType":"Invoke","apiName":"NewContact","externalId":"00D58000000arpq:00158000006QBOhAAO::RelatedList:Desktop:StandardButton:NewContact","iconUrl":"https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_contact_120.png","id":"0JV4H0000119415WAA","isMassAction":"false","label":"New","lwcComponent":null,"primaryColor":"5867E8","relatedListRecordId":null,"relatedSourceObject":"Contacts","section":"Page","sourceObject":"00158000006QBOhAAO","subtype":null,"targetObject":"Contact","targetUrl":null,"type":"StandardButton"}],"links":[],"url":"/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list/Contacts"}},"eTag":"a20a5831cc59f674f527261d7469d62d","url":"/services/data/v58.0/ui-api/actions/record/00158000006QBOhAAO/related-list/Contacts"}