Contacts

Search contacts

Search for one or more contacts.

get/v1/Contacts

Request

Query parameters

search.contact_idinteger[]

Query by contact identifier.

search.customer_idinteger[]

Query by account identifier.

search.contact_type_idinteger[]

Query by type identifier.

search.namestring[]

Query by all or part of name.

search.emailstring[]

Query by all or part of email addresss.

search.mobilestring[]

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

search.companystring[]

Query by all or part of company name.

search.titlestring[]

Query by all or part of title.

search.phonestring[]

Query by all or part of the phone number.

search.faxstring[]

Query by all or part of the fax number.

search.created_date_startstring date-time

Return only entries created after this date.

search.created_date_endstring date-time

Return only entries created before this date.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

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

search.sortstring

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

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.