Search Engagements

Arguments

stringrequired

The CRM activity object type to search, such as notes, tasks, calls, emails, or meetings.

object

Use HubSpot filter groups to find activities linked to a record. For deal activity, use `associations.deal` with `EQ` and the deal ID. You can also use `associations.contact` or `associations.company`.

array of object

Filters combined with AND semantics inside one filter group. For deal activity, add a filter using `associations.deal` and the deal ID.

string

HubSpot property to filter on. For related-record activity lookups, use `associations.deal`, `associations.contact`, or `associations.company`.

string

Comparison operator for the filter. `EQ` is the usual choice for association filters such as `associations.deal = <dealId>`.

string

Single comparison value for the filter. For deal activity lookups, pass the deal ID such as `9018868490`.

array of string

Properties to return for each activity. For deal emails, try `hs_email_subject`, `hs_email_text`, `hs_email_from_email`, `hs_email_to_email`, and `hs_timestamp`. For deal notes, try `hs_note_body` and `hs_timestamp`.

string

Optional full-text query applied to the default searchable properties for the selected activity type.

Uncommon arguments

number

Maximum number of records to return in this search page.

string

Paging cursor for the next search page.

array of string

Sort clauses to apply to the search results.

array of string

Multiple comparison values for IN and NOT_IN filters.

string

Upper bound value for BETWEEN filters.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Query

Every app you connect,one REST pattern