Actionable List Definition Records (POST)

Get records and column metadata for an actionable list definition. Use filters, sorting, and pagination to refine the results.

Resource

1/connect/actionable-list-definitions/ACTIONABLE_LIST_DEFINITION_ID/records

Available Version

68.0

HTTP Methods

POST

URI Parameters

Parameter Name	Type	Description	Required
`actionableListDefinitionId`	String	ID of the actionable list definition whose records you want to get.	Required

Request Body for POST

JSON Example

1{
2  "pageLimit": 200,
3  "offset": 0,
4  "orderBy": "Name",
5  "sortOrder": "ASC",
6  "filterLogic": "1 AND 2 AND 3",
7  "queryId": "MTAuMjIuMTQ4LjE4MTo3NDg0%2Fe1025a17-0ff7-bcb9-204c",
8  "filters": [
9    {
10      "columnName": "Name",
11      "operator": "equals",
12      "values": ["Sam"]
13    },
14    {
15      "columnName": "City__c",
16      "operator": "in",
17      "values": ["San Francisco", "San Jose", "Santa Clara"]
18    },
19    {
20      "columnName": "Value",
21      "operator": "equals",
22      "values": ["1000"]
23    }
24  ]
25}

Properties

Property Name	Type	Description	Required
`pageLimit`	Integer	Maximum number of records to return.	Optional
`offset`	Integer	Number of records to skip before returning the results.	Optional
`filterLogic`	String	Logical expression that combines filter criteria to apply for retrieving the records.	Optional
`filters`	Filter Input[]	List of filter criteria. See Filter Input.	Optional
`orderBy`	String	Name of the column to sort the records by.	Optional
`sortOrder`	String	Direction to sort the results, such as ascending or descending.	Optional
`queryId`	String	A unique identifier that’s used to retrieve the remaining records from a long-running query. If the initial request doesn’t return the complete dataset, the response includes a new query ID. Pass this latest query ID in your subsequent request to fetch the next batch of results.	Optional

Response Body for POST

Actionable List Definitions Records