Sign in
Contact

List all existing contacts

get/v1/contacts

Query parameters

Idinteger
DepartmentIdinteger
CompanyIdinteger
FullNamestring
FirstNamestring
LastNamestring
Emailstring
Phonestring
Example:12124567890

Phone number with country code, without leading + (plus) sign, minimum 4 digits or empty. Items having a phone number that starts with the given value will be returned.

GroupIdsstring
Addressstring
Statestring
Citystring
Townstring
CountryCodestring
Jobstring
Statusstring
<p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul>
<p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul><p>Enum values:</p><ul><li><i>C = Customer</i></li><li><i>L = Lead</i></li><li><i>P = Prospect</i></li><li><i>O = Lost</i></li><li><i>R = Reseller</i></li><li><i>T = Partner</i></li><li><i>S = Supplier</i></li></ul>
Blockedinteger
FromCreatedDatestring
ToCreatedDatestring
CustomFieldsobject
Qstring
Fieldsstring
DepartmentScopeDepartmentPageSelection

Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.

Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.

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
isExportboolean

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.