[GET] - Contact Lookup – InsideView

Use the Target API's Contact Lookup endpoint to search new contacts in a specific company.

The elements in the contact list contain a newid value and enough additional information such that a user could narrow down a selection from the list. Using the selected newid values you can retrieve additional contact information through the Target API's New Contact Details endpoint.

Endpoint

GET https://api.insideview.com/api/v1/target/company/{companyId}/contacts

Request

HTTP Headers

Header Name	Type	Required	Description
accessToken	String	Yes	Valid access token. See Authentication and Authorization Overview for more details.
Accept	String	No	Selects the response's content type. Valid values are application/json and application/xml (default).

URI Parameters

Parameter Name	Type	Required	Description
companyId	string	Yes	A valid string and integer company ID

Query Parameters

Parameter Name	Type	Required	Description
jobFunctionsV2	Integer	No	A comma-separated list of a newer version of job function ID. See API Reference data for a list of IDs.
jobLevelsV2	Integer	No	A comma-separated list of a newer version of job level ID. See API Reference data for a list of IDs.
jobFunction	Integer	No	A comma-separated list of job function ID. See API Reference data for a list of IDs.
jobLevel	Integer	No	A comma-separated list of job level ID. See API Reference data for a list of IDs.
keyword	String	No	Keyword string that will be matched against titles
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
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.
phoneType	String	No	Accepts DIRECT, CORP, MOBILE, and ANY to find the corresponding contact's phone numbers. Note: The Direct phone number is only available for InsideView customers and not OEM partners. Mobile phone numbers are now available via the InsideView APIs for customers and partners who have purchased Elite or the mobile phone add-on to Enterprise.
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
hasContactInfo	Boolean	No	Pass it as 'true' to filter contacts with either a phone number or email. When you pass it as 'false', contact records in response will neither have a phone number nor email.

1: the request should include at least one of the three mandatory parameters.

HTTP 200 Responses

Here are the major responses the API may return.

for details on the errors, please refer to the API Error Codes article.

Returns either a JSON or XML data structure depending on the request Accept header.

Name	type	Description
contacts	Array	Array of search results
contacts > contactId	String	InsideView New 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 > emailMD5Hash	String	MD5 hash of the contact's email
contacts > active	Boolean	Indicate if the contact record corresponds to an active or inactive employment
contacts>emailValidationStatus	String	Indicates the status of the email such as ValidEmail or ValidDomain
contacts > hasEmail	Boolean	Indicate if the contact record includes an email address
contacts > hasPhone	Boolean	Indicate if the contact record includes a phone number
contacts >phoneType	String	Indicate if the contact record includes a corporate, direct or mobile phone number of an executive
contacts > hasFacebookHandle	Boolean	Indicate if the contact record includes a Facebook handle
contacts > hasLinkedinHandle	Boolean	Indicate if the contact record includes a LinkedIn handle
contacts > hasTwitterHandle	Boolean	Indicate if the contact record includes a Twitter handle
contacts>jobLevels	List	List of job levels ( String )
contacts>jobFunctions	List	List of job functions ( String )
contacts>peopleId	String	People id of the contact
page	Integer	Page number in the result set
resultsPerPage	Integer	Number of search result per page
totalResults	Integer	Total number of search results

application/json Example

{
  "totalResults": 1315,
  "page": 1,
  "resultsPerPage": 2,
  "contacts": [
    {
      "contactId": "RciV4L2fOsbJI0KsBj0TuHo9806nTZL5e2JIkb2GwOCCyHhW2Ozhiwfm4WoS4doR",
      "companyId": 736233,
      "currentCompanyId": 1755
      "companyName": "Alphabet Inc",
      "titles": [
        "Regional Director Sales and Marketing, New York"
      ],
      "emailMd5Hash": "9c6ac98b85de5355eb59bbce8bd53325",
      "emailValidationStatus": "ValidDomain",
      "emails":[
         {
          "emailMd5Hash": "9c6ac98b85de5355eb59bbce8bd53325",
          "validationStatus": "ValidDomain",
         }
       ],
      "hasPhone": true,
      "phoneType": MOBILE,
      "hasEmail": true,
      "hasFacebookHandle": false,
      "hasTwitterHandle": false,
      "hasLinkedInHandle": true,
      "active": true,
      "jobLevels": [
        "4"
      ],
      "jobFunctions": [
        "1",
        "2"
      ],
      "jobLevelsV2": [
          {
            "id": "0",
            "name": "Board Member"
          },
          {
            "id": "1",
            "name": "C Level"
          }
      ],
      "jobFunctionsV2": [
          {
            "id": "22",
            "name": "Others"
          }
      ],
      "peopleId": "CZaknPf4l0H6ELscK38Bk0smwIV7L1LP0RVvP0DWCtyFnQh4yyWo0YEVt6uwNZZf"
    },
    {
      "contactId": "RciV4L2fOsbJI0KsBj0TuBj_AwSHsW-ijU0xRRBvUjGg8VTlV72udRhCtXCbbHpI",
      "companyId": 736233,
      "companyName": "Alphabet Inc",
      "titles": [
        "Head of Inside Sales"
      ],
      "hasPhone": true,
      "hasEmail": false,
      "active": true,
      "jobLevels": [
        "4"
      ],
      "jobFunctions": [
        "1"
      ],
      "jobLevelsV2": [
          {
            "id": "0",
            "name": "Board Member"
          },
          {
            "id": "1",
            "name": "C Level"
          }
      ],
      "jobFunctionsV2": [
          {
            "id": "22",
            "name": "Others"
          }
      ],
      "peopleId": "btgyPsJShJcSBfjdjzIuuB261vO3zENxWosvOqM0DLTEDItI_Vm_HX3NqqOVyKxM"
    }
  ]
}

application/xml Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contacts>
    <contact>
        <active>true</active>
        <companyId>736233</companyId>
        <currentCompanyId>1755</currentCompanyId>
        <companyName>Alphabet Inc</companyName>
        <contactId>RciV4L2fOsbJI0KsBj0TuHo9806nTZL5e2JIkb2GwOCCyHhW2Ozhiwfm4WoS4doR</contactId>
        <confidenceScore>0.8</confidenceScore>
        <emailMd5Hash>9c6ac98b85de5355eb59bbce8bd53325</emailMd5Hash>
        <emailValidationStatus>ValidDomain</emailValidationStatus>
        <emails>
          <email>
             <emailMd5Hash>9c6ac98b85de5355eb59bbce8bd53325</emailMd5Hash>
             <ValidationStatus>ValidDomain</ValidationStatus>
          </email>
        </emails>
        <hasEmail>true</hasEmail>
        <hasFacebookHandle>false</hasFacebookHandle>
        <hasLinkedInHandle>true</hasLinkedInHandle>
        <hasPhone>true</hasPhone>
        <phoneType>MOBILE</phoneType>
        <hasTwitterHandle>false</hasTwitterHandle>
        <jobFunctions>
            <jobFunction>1</jobFunction>
            <jobFunction>2</jobFunction>
        </jobFunctions>
        <jobLevels>
            <jobLevel>4</jobLevel>
        </jobLevels>
        <peopleId>CZaknPf4l0H6ELscK38Bk0smwIV7L1LP0RVvP0DWCtyFnQh4yyWo0YEVt6uwNZZf</peopleId>
        <titles>Regional Director Sales and Marketing, New York</titles>
    </contact>
    <contact>
        <active>true</active>
        <companyId>736233</companyId>
        <companyName>Alphabet Inc</companyName>
        <contactId>RciV4L2fOsbJI0KsBj0TuBj_AwSHsW-ijU0xRRBvUjGg8VTlV72udRhCtXCbbHpI</contactId>
        <confidenceScore>0.76</confidenceScore>
        <emailMd5Hash>23b23f15fa471046259fb84bd1bb5bad</emailMd5Hash>
        <emailValidationStatus>ValidDomain</emailValidationStatus>
        <emails>
          <email>
             <emailMd5Hash>23b23f15fa471046259fb84bd1bb5bad</emailMd5Hash>
             <ValidationStatus>ValidDomain</ValidationStatus>
          </email>
        </emails>
        <hasEmail>false</hasEmail>
        <hasPhone>true</hasPhone>
        <jobFunctions>
            <jobFunction>1</jobFunction>
        </jobFunctions>
        <jobLevels>
            <jobLevel>4</jobLevel>
        </jobLevels>
        <jobLevelsV2>
            <jobLevelV2>
                <id>0</id>
                <name>Board Member</name>
            </jobLevelV2>
            <jobLevelV2>
                <id>2</id>
                <name>Senior Executive</name>
            </jobLevelV2>
        </jobLevelsV2>
        <jobFunctionsV2>
            <jobFunctionV2>
                <id>22</id>
                <name>Others</name>
            </jobFunctionV2>
        </jobFunctionsV2>
        <peopleId>btgyPsJShJcSBfjdjzIuuB261vO3zENxWosvOqM0DLTEDItI_Vm_HX3NqqOVyKxM</peopleId>
        <titles>Head of Inside Sales</titles>
    </contact>
    <page>1</page>
    <resultsPerPage>2</resultsPerPage>
    <totalResults>1315</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.

Articles in this section

[GET] - Contact Lookup