Get a bulk companies job

Request

You can check the status of a bulk companies job. The state field indicates the overall job progress: pending, running, completed, or completed_with_errors.

Security

bearerAuth

Path

idstringrequired

The unique identifier for the bulk job.

Example:job_v2_1

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"Preview"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X GET \
  https://api.intercom.io/companies/bulk/job_v2_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

successful

Bodyapplication/json

idstring

The unique identifier for the bulk job.

Example:"job_v2_1"

typestring

The type of the object.

Value:"companies.bulk.job"

Example:"companies.bulk.job"

statestring

The current state of the job.

Enum:"pending""running""completed""completed_with_errors"

Example:"running"

created_atinteger, (date-time)

The time the job was created as a UNIX timestamp.

Example:1713360000

updated_atinteger, (date-time)

The time the job was last updated as a UNIX timestamp.

Example:1713360060

completed_atinteger or null, (date-time)

The time the job completed as a UNIX timestamp. Null if not yet completed.

Example:1713360120

tasksArray of objects

The tasks that make up this bulk job.

urlstring

The URL to check the job status.

Example:"https://api.intercom.io/companies/bulk/job_v2_1"

Response

{
  "id": "job_v2_1",
  "type": "companies.bulk.job",
  "state": "completed",
  "created_at": 1713360000,
  "updated_at": 1713360120,
  "completed_at": 1713360120,
  "tasks": [
    { … }
  ],
  "url": "https://api.intercom.io/companies/bulk/job_v2_1"
}