Articles in this section

See more

[POST] - Contact Lookup Job

Nitin Singh Sisodia
  • Updated
Follow

Use the Contact Lookup Job endpoint to submit the bulk of Contact Lookup queries.  It creates an asynchronous job on InsideView servers.  Refer to Using the bulk API article for more details.

Endpoint

POST https://api.insideview.com/api/v1/target/contact/job

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes The 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).

Query Parameters

Parameter Name Type Required Description
webhook String No URL for receiving Job-status 

 

Request Body

The request body should contain a list of Contact Lookup queries as CSV data.  The request can contain up to 2,000 lines.  Each line should contain the following fields:

Field Type Required Description
queryId String Yes An identifier for the query
companyID Integer Yes A valid InsideView Company ID
jobLevel String Yes1 A comma-separated list of job level IDs.
See API Reference data for a list of IDs.
jobFunction String Yes1 A comma-separated list of job function IDs.
See API Reference data for a list of IDs
title String Yes1 Keyword string that will be matched against titles
active Boolean No2 Returns only active or inactive employments.  
Default: true
isPhoneRequired Boolean No2 If present and equals to true returns only record with phone number. 
isEmailRequired Boolean No2 If present and equals to true returns only record with an email address.
peopleCountries String No2 A comma-separated list of people country Ids 
peopleStates String No2 A comma-separated list of people states 
peopleCities String No2 A comma-separated list of people cities 
peopleArea  String No2 People area name, ex: Greater San Diego Area
peopleAddress  String No2 People address ex: Pico Rivera, California
phoneType String No Accepts DIRECT, CORP, and ANY to find the corresponding contact's phone numbers.
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.  
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: At least one of the 3 options should not be empty
2: the 3 options should be present if one at least is used

Example input data

1,781163,"2,1",,,,,,,
2,736233,1,,,,,,,
3,730247,,,,,,,
4,640139,,2,,,,,,
5,726263,7,,,,,,,
6,726579,9,,,,,,,
7,725038,11,,,,,,,
8,13249,,20,,,,,,
9,781163,,,ceo,,,,
10,1442719,,,managing director,,,,
11,24870,,,csm's,,,,

Responses

Here are the major responses the API may return.

This API returns email validation status in a .CSV response file, which you can download.

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

HTTP 200

An HTTP 200 status means the data have been accepted and a job has been queued.

application/JSON example response

{
  jobId: "peerukbkasr85s6hdtb9"
  status: "accepted"
  type: "targetLookup"
}

application/JSON example response

<?xml version="1.0" encoding="UTF-8"?>
<BulkJobStatus>
 <jobId>a8bpdds1one7vblg0obm</jobId>
 <status>accepted</status>
 <type>peopletab</type>
</BulkJobStatus>

HTTP 400

An HTTP 400 error code may have several causes:

  • Validation of input data failed
  • Insufficient transaction quota available
  • Too many jobs submitted to the processing queue
  • etc.

HTTP 401

Unauthorized Error - Cannot use API without setting a valid accessToken in the header.

HTTP 405

Method Not Allowed - You are not allowed to access this API.

HTTP 415

The Content-Type mandatory is not valid, please refer to the API documentation.

HTTP 429

The request is throttled.

 

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk