[GET] - Contact Lookup

Follow

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 Integer Yes A valid company ID

Query Parameters

Parameter Name Type Required Description
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.
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

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 correspond to an active or inactive employment
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 > 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,
      "companyName": "Alphabet Inc",
      "titles": [
        "Regional Director Sales and Marketing, New York"
      ],
      "emailMd5Hash": "9c6ac98b85de5355eb59bbce8bd53325",
      "hasPhone": true,
      "hasEmail": true,
      "hasFacebookHandle": false,
      "hasTwitterHandle": false,
      "hasLinkedInHandle": true,
      "active": true,
      "jobLevels": [
        "4"
      ],
      "jobFunctions": [
        "1",
        "2"
      ],
      "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"
      ],
      "peopleId": "btgyPsJShJcSBfjdjzIuuB261vO3zENxWosvOqM0DLTEDItI_Vm_HX3NqqOVyKxM"
    }
  ]
}

application/xml Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contacts>
    <contact>
        <active>true</active>
        <companyId>736233</companyId>
        <companyName>Alphabet Inc</companyName>
        <contactId>RciV4L2fOsbJI0KsBj0TuHo9806nTZL5e2JIkb2GwOCCyHhW2Ozhiwfm4WoS4doR</contactId>
        <emailMd5Hash>9c6ac98b85de5355eb59bbce8bd53325</emailMd5Hash>
        <hasEmail>true</hasEmail>
        <hasFacebookHandle>false</hasFacebookHandle>
        <hasLinkedInHandle>true</hasLinkedInHandle>
        <hasPhone>true</hasPhone>
        <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>
        <hasEmail>false</hasEmail>
        <hasPhone>true</hasPhone>
        <jobFunctions>
            <jobFunction>1</jobFunction>
        </jobFunctions>
        <jobLevels>
            <jobLevel>4</jobLevel>
        </jobLevels>
        <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.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk