[POST] - Company Details Job

Follow

Use this endpoint to submit a bulk request of Company Details queries.  It creates an asynchronous job on InsideView servers.  Refer to Using the bulk API article for more details.

The company ids can be obtained either through the Data API Company Search or through the Enrich API Enrich (or its bulk version).

Endpoint

POST https://api.insideview.com/api/v1/company/job

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).
Accept-Language String No Select the response's language and locale.
Default value: en-en
See Internationalization Support for more details.
Content-Type String No Input content type
application/octet-stream
 or text/plain

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 company ids, either separated with commas or a new line.  The request can contain up to 10,000 company ids.  

Example input data (1)

736233,781163,724468

Example input data (2)

736233
781163
724468

Responses

Here are the major responses the API may return.

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 have been queued.

application/json example response

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

application/json example response

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

HTTP 400

An HTTP 400 error code may have several causes:

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

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 415

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

HTTP 429

Request is throttled.

 

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