Search contacts

Search for one or more contacts.

Query Params
search.contact_id
array of int32s

Query by contact identifier.

search.contact_id
search.customer_id
array of int32s

Query by account identifier.

search.customer_id
search.contact_type_id
array of int32s

Query by type identifier.

search.contact_type_id
search.name
array of strings

Query by all or part of name.

search.name
search.email
array of strings

Query by all or part of email addresss.

search.email
search.mobile
array of strings

Query by all or part of mobile/cellular phone number.

search.mobile
search.company
array of strings

Query by all or part of company name.

search.company
search.title
array of strings

Query by all or part of title.

search.title
search.phone
array of strings

Query by all or part of the phone number.

search.phone
search.fax
array of strings

Query by all or part of the fax number.

search.fax
date-time

Format - date-time (as date-time in RFC3339). Return only entries created after this date.

date-time

Format - date-time (as date-time in RFC3339). Return only entries created before this date.

int32

Format - int32. Defines how many items to return at a time.

int32

Format - int32. Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

string

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/html