Skip to main content
POST
Search Records Task
Provider API: Salesforce REST API (Latest version available to the connected org).

Authorizations

Authorization
string
header
required

Your Paragon User Token (JWT), which you can generate using your project's signing keys.

Path Parameters

project_id
string
required

Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.

Body

application/json
tool
string
default:SALESFORCE_SEARCH_RECORDS_TASK
required
parameters
object
required

Response

200 - application/json

A page of Salesforce query results. records is the Salesforce query response, with the matching records in records.records. When more results are available, nextPageCursor is the nextRecordsUrl from Salesforce; pass it as paginationParameters.pageCursor to load the next page. On the last page, nextRecordsUrl and nextPageCursor are omitted. If includeAllFields is true, nextPageCursor is an offset-based cursor such as OFFSET__200 and is always returned, including on the last page.