Search Contacts

POST

Body

Arguments

stringrequired

HighLevel location ID to search contacts in.

string

Optional free-text contact search query. Verified with HighLevel's query field.

string

Optional email filter. Use Email Match to choose exact or partial matching.

string

Choose how the Email filter should match. Contains supports partial email searches; Exact matches one email address.

date

Only return contacts updated on or after this date/time. The action sends this as HighLevel's dateUpdated range filter.

date

Only return contacts updated on or before this date/time. The action sends this as HighLevel's dateUpdated range filter.

Uncommon arguments

array of object

Optional array of sort objects, for example [{"field":"dateAdded","direction":"desc"}].

array of object

Advanced: optional array of HighLevel filter objects, for example [{"field":"email","operator":"contains","value":"example"}]. Friendly fields like Email and Updated After/Before are merged into this array.

object

Optional raw base JSON body for HighLevel's POST /contacts/search endpoint. Explicit arguments on this action override matching keys in this object.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

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

string

Comma-separated response fields to include.

Body

Every app you connect,one REST pattern