Search for data
search
(array[[string]]) which allows you to specify multiple search terms. These terms will be combined using an AND operator. At the moment, there is no support for other logical operators.
An API endpoint that supports searching will specify in its documentation which fields are searchable. The description will list all the fields that can be used with the search parameter, such as ‘email’, ‘phone’, ‘name’, etc.
This GET Contacts endpoint supports searching for email, phone, and name.
Operator | Description |
---|---|
: | Equals |
:! | Not equal to |
:> | Greater than |
:>= | Greater than or equal |
:< | Less than |
:<= | Less than or equal |
*
can be used:
Example term | Description |
---|---|
john* | Will search the field for values starting with ‘john’ |
*john | Will search the field for values ending with ‘john’ |
*john* | Will search the field for values containing with ‘john’ |