Sign in
Contact

Performs a text search on contacts and returns the matching results

get/v1/contacts/search

Query parameters

Querystring required
Fieldsstring
SearchInActivitiesboolean

Executes the search in activities (notes, emails, calls, meetings, etc.)

SearchType0 | 1 | 2
<p>Enum values:</p><ul><li><i>0 = Smart</i></li><li><i>1 = Exact</i></li><li><i>2 = Fuzzy</i></li></ul>

Search type: Smart (default), Exact, Fuzzy<p>Enum values:</p><ul><li><i>0 = Smart</i></li><li><i>1 = Exact</i></li><li><i>2 = Fuzzy</i></li></ul>

Fuzziness0 | 1 | 2 | 3
<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Auto</i></li><li><i>2 = Low</i></li><li><i>3 = High</i></li></ul>

Fuzzy tolerance: None (default), Auto, Low (1), High (2)<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Auto</i></li><li><i>2 = Low</i></li><li><i>3 = High</i></li></ul>

ViewType0 | 1
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul><p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
Pageinteger
ItemsPerPageinteger
ReturnTotalItemsboolean
sortColstring
sortDirstring

Response

OK

totalItemsinteger

Example response

{
  "items": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "phone": "12124567890",
      "countryCode": "US",
      "department": "Product",
      "job": "Software Engineer",
      "color": "#4c65ff"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.