[POST] - Asynchronous (batch) Target Company List Build API

Use this endpoint to build a list a companies using rich filters in batch mode.

The elements in the companies 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 company information through the Target API's New Company Details endpoint.

Endpoint

POST https://api.insideview.com/api/v1/target/companies/export/job

Request

HTTP Headers

Form Parameters

pageIntegerNoDefault: 1

Responses

Here are the major responses the API may return.

For details on the errors, see API Error Codes.

HTTP 200

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

Type: application/json

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/",
  "type": "object",
  "properties": {
    "jobId": {
      "id": "jobId",
      "type": "string"
    },
    "status": {
      "id": "status",
      "type": "string"
    },
    "type": {
      "id": "type",
      "type": "string"
    }
  }
}

Example

{
  "jobId": "lnjkd7ie0hblp1k58e5q",
  "status": "accepted",
  "type": "targetCompanySearchAsyncExport"
}

Type: application/xml

Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:element name="BulkJobStatus" type="BulkJobStatusDTO"/>

    <xs:complexType name="BulkJobStatusDTO">
        <xs:sequence>
            <xs:element name="jobId" type="xs:string" />
            <xs:element name="status" type="xs:string" />
            <xs:element name="type" type="xs:string" />     
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BulkJobStatus>
    <jobId>s04eabq2bt0ncgpa1095</jobId>
    <status>accepted</status>
    <type>targetCompanySearchAsyncExport</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.