Search (SOSL)
Overview
The SOSL action performs a Salesforce Object Search Language query on a single object. SOSL allows for text-based searches and behaves similar to the search box within Salesforce.
Inputs
Search Text
Text used to perform the search.
| Type | Required |
|---|---|
| Text | true |
Object API Name
API name of the Salesforce object to search.
| Type | Required |
|---|---|
| Text | true |
Fields to Return
Comma-separated value of API Field Names that return when performing the search.
| Type | Required |
|---|---|
| Text | true |
Search Scope
Controls the fields searched when performing the search.
| Type | Default | Valid Values |
|---|---|---|
| Text | ALL FIELDS | ALL FIELDS NAME FIELDS EMAIL FIELDS PHONE FIELDS SIDEBAR FIELDS |
Order By Field
API name of the field to use for sorting the results.
| Type |
|---|
| Text |
Order By Direction
Controls the sort order of the results when the Order by Field input option is set.
| Type |
|---|
| Text |
Limit
Limits the number of records returned by the search.
| Type |
|---|
| Number |
Outputs
Records
The records output contains the list of records returned by the search.
| Type | Variable Name |
|---|---|
| Record Collection | records |