Use the Contacts Search endpoint to fetch a list of contacts.
The elements in the contacts list contain an id value and enough additional information such that a user could narrow down a selection from the list. Using the selected id values, you can retrieve additional contact information through the Contact Details endpoint.
Note: Please use filters to limit the list size to below 100K per API call.
Endpoint
GET https://api.insideview.com/api/v1/contacts
Request
HTTP Headers
Header Name | Type | Required | Description |
accessToken | String | Yes |
Valid access token. |
Accept | String | No | Selects the response's content type. Valid values are application/json and application/xml (default). |
Query Parameters
Parameter Name | Type | Required | Description |
String | Yes1 | Contact email | |
lastName | String | Yes1 | Contact last name |
firstName | String | No | Contact first name |
middleName | String | No | Contact middle name |
fullName | String | Yes1 | Contact Full Name |
country | String | No | Country name (e.g. United States, France) for company search |
state | String | No | State name for company search |
city | String | No | City Name of company search |
zip | String | No | Zip code for company search |
peopleCountries | String | No | Comma separated list of Country Ids |
peopleStates | String | No | Comma separated list of States |
peopleCities | String | No | Comma separated list of Cities |
peopleArea | String | No | Area for the search |
peopleAddress | String | No | Address for the search |
companyId | Integer | No | Contact current Company Id |
companyName | String | No | Contact current Company Name |
companyWebsite | String | No | Contact current Company website (Only as Relevence filter) |
active | String | No | If present will return only active or inactive records, depending on the value (true or false) |
isEmailRequired | String | No | If present and equals to true, the API will return only contact having an email address. |
isPhoneRequired | String | No | If present and equals to true, the API will return only contact having a phone number. |
emailValidationStatus | String | No | It allows you to retrieve the validation status of the email. You can enter a comma-separated string with possible values i.e. ValidDomain and ValidEmail. |
minContactConfidenceScore | String | No | The minimum contact confidence score. The valid values range from 0 to 100. |
maxContactConfidenceScore | String | No | The maximum contact confidence score. The valid values range from 0 to 100. |
page | Integer | No | The page number of the result-set to return. Default: 1 |
resultsPerPage | Integer | No | The number of results in a page request. Min: 1, Max: 50, Default: 10 |
phoneType | String | No | Accepts DIRECT, CORP, and ANY to find the corresponding contact's phone numbers. |
titles | String | No | Return the job titles of an executive. |
1: the request should include at least one of the two mandatory parameters.
Responses
HTTP 200
Returns either a JSON or XML data structure depending on the request Accept header.
Name | type | Description |
contacts | Array | Array of search results |
contacts > firstName | String | Contact's first name |
contacts > middleName | String | Contact's middle name |
contacts > lastName | String | Contact's last name |
contacts > contactId | String | InsideView Contact ID |
contacts > companyId | Integer | Contact's InsideView Company ID |
contacts > companyName | String | Contact's company name |
contacts > titles | List | List of titles (String) |
contacts > active | Boolean | Active / inactive employment flag |
contacts > hasEmail | Boolean | True if the contact has an email address |
contacts > hasPhone | Boolean | True if the contact has a phone number |
contacts > peopleId | String | Return People Id |
page | Integer | Page number in the result set |
resultsPerPage | Integer | Number of search result per page |
totalResults | Integer | Total number of search results |
phoneType | String | Returns CORPORATE and DIRECT phone number of an executive. |
titles | String | Title of an executive |
application/json example
{ "totalResults": 5, "page": 1, "resultsPerPage": 50, "contacts": [ { "firstName": "Umberto", "middleName": "", "lastName": "Milletti", "contactId": 8802619, "companyId": 781163, "companyName": "InsideView, Inc..", "titles": [ "Chief Executive Officer & Founder" ], "active": true, "hasEmail": false, "hasPhone": true,
"phoneType": CORP, "peopleId": "544KN90XokCKSBrKF8FkX_Eszq2JCMDfzMjbglyzLVXd0TDdVA0GymiRy4BesdZ-" "corporate: 949-XXX-XXX,
"direct": 935-XXXX-XXXX,
}, { "firstName": "Umberto", "lastName": "Milletti", "contactId": 15698563, "companyId": 1023451, "companyName": "Sand Hill Group, LLC", "titles": [ "Founder, CEO On CRM And Big Data Customer Analytics Trends" ], "active": true, "hasEmail": false, "hasPhone": true,
"phoneType": CORP, "peopleId": "1WhHImR7pXLvHsM8ffnIoYNAcybxe7gRjKBFouZWQgLxrZdvbLCHDCxzy7qtZ9BH" }, { "firstName": "Francesca", "lastName": "Milletti", "contactId": 20279037, "companyId": 811176, "companyName": "Roche Holding AG", "titles": [ "Principal Scientist, Data Science" ], "active": true, "hasEmail": true, "hasPhone": true,
"phoneType": DIRECT, "peopleId": "ewp__T0qXfw_9mDh2b4afxGcStBWTX_QQU7BPVewEfXuz1i-4c42q3zxhH8LoiLs" }, { "firstName": "Alessandro", "middleName": "", "lastName": "Milletti", "contactId": 24939268, "companyId": 12187785, "companyName": "Crs4 Srl", "titles": [ "Director" ], "active": true, "hasEmail": false, "hasPhone": true,
"phoneType": DIRECT, "peopleId": "NZ30nmuF51Z7fsFoZ149FMluJjhDjAIrj9YqX_W_rwf2zrunHuwl_OfeX6laN2mV" }, { "firstName": "Umberto", "lastName": "Milletti", "contactId": 50159972, "companyId": 1601884, "companyName": "The College Company, Inc.", "titles": [ "Advisor" ], "active": true, "hasEmail": false, "hasPhone": true,
"phoneType": CORP, "peopleId": "fTTvhwWDCvn23V4uYR93zbGObNbGMd9daHAwF3N-rUixgfgyikf_D7SvjPAJZo6n"
} ] }
application/xml example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <contacts> <contact> <active>true</active> <companyId>781163</companyId> <companyName>InsideView, Inc..</companyName> <contactId>8802619</contactId> <firstName>Umberto</firstName> <hasEmail>false</hasEmail> <hasPhone>true</hasPhone>
<phoneType>CORP</phoneType> <lastName>Milletti</lastName> <middleName></middleName> <peopleId>544KN90XokCKSBrKF8FkX_Eszq2JCMDfzMjbglyzLVXd0TDdVA0GymiRy4BesdZ-</peopleId> <titles>Chief Executive Officer & Founder</titles>
<corporatePhone>+44 800 039 1010</corporatePhone>
<directPhone>+939 4321 3433</directPhone> </contact> <contact> <active>true</active> <companyId>1023451</companyId> <companyName>Sand Hill Group, LLC</companyName> <contactId>15698563</contactId> <firstName>Umberto</firstName> <hasEmail>false</hasEmail> <hasPhone>true</hasPhone>
<phoneType>DIRECT</phoneType> <lastName>Milletti</lastName> <peopleId>1WhHImR7pXLvHsM8ffnIoYNAcybxe7gRjKBFouZWQgLxrZdvbLCHDCxzy7qtZ9BH</peopleId> <titles>Founder, CEO On CRM And Big Data Customer Analytics Trends</titles> </contact> <contact> <active>true</active> <companyId>811176</companyId> <companyName>Roche Holding AG</companyName> <contactId>20279037</contactId> <firstName>Francesca</firstName> <hasEmail>true</hasEmail> <hasPhone>true</hasPhone>
<phoneType>CORP</phoneType> <lastName>Milletti</lastName> <peopleId>ewp__T0qXfw_9mDh2b4afxGcStBWTX_QQU7BPVewEfXuz1i-4c42q3zxhH8LoiLs</peopleId> <titles>Principal Scientist, Data Science</titles> </contact> <contact> <active>true</active> <companyId>12187785</companyId> <companyName>Crs4 Srl</companyName> <contactId>24939268</contactId> <firstName>Alessandro</firstName> <hasEmail>false</hasEmail> <hasPhone>true</hasPhone>
<phoneType>DIRECT</phoneType> <lastName>Milletti</lastName> <middleName></middleName> <peopleId>NZ30nmuF51Z7fsFoZ149FMluJjhDjAIrj9YqX_W_rwf2zrunHuwl_OfeX6laN2mV</peopleId> <titles>Director</titles> </contact> <contact> <active>true</active> <companyId>1601884</companyId> <companyName>The College Company, Inc.</companyName> <contactId>50159972</contactId> <firstName>Umberto</firstName> <hasEmail>false</hasEmail> <hasPhone>true</hasPhone>
<phoneType>CORP</phoneType> <lastName>Milletti</lastName> <peopleId>fTTvhwWDCvn23V4uYR93zbGObNbGMd9daHAwF3N-rUixgfgyikf_D7SvjPAJZo6n</peopleId> <titles>Advisor</titles> </contact> <page>1</page> <resultsPerPage>50</resultsPerPage> <totalResults>5</totalResults> </contacts>
HTTP 400
Invalid query parameter(s).
HTTP 401
Unauthorized Error - Cannot use API's without setting a valid accessToken in header.
HTTP 405
Method Not Allowed - Your are not allowed to access this API.
HTTP 429
Request is throttled.
Comments
0 comments
Please sign in to leave a comment.