Search contacts

get

https://app2.gettruss.io/api/v1/contacts/search

Search and filter contacts using various criteria

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

query

string

Search by email, first name, or last name (prefix match on primary email)

tag

string

Filter by a single tag name

sort

string

enum

Defaults to last_name

Column to sort by

Allowed:

direction

string

enum

Defaults to asc

Sort direction

Allowed:

query_type

string

enum

Defaults to and

How to combine advanced filters (used with filters parameter)

Allowed:

filters

array of objects

Advanced filtering array. Each filter has type, field, criteria, and value/values. NOTE: Swagger UI generates filters[0][field]=tags format. Manually change [0] to [] for Rails: filters[][field]=tags For enum fields (tags, owner): filters[][type]=enum&filters[][field]=tags&filters[][criteria]=has_any_of&filters[][values][]=tag1 For string fields: filters[][type]=string&filters[][field]=first_name&filters[][criteria]=starts_with&filters[][value]=John

filters

Response

200Successful response with filtered contacts