Intercom API (unofficial showcase)
GET/contacts/bulk/{id}

Get a bulk contact job

Retrieves the status of an asynchronous bulk contact job. Supply the job's id to view its overall state, task details, and timestamps. Use the state to determine whether processing is pending, running, completed, or completed with errors.

2 parameters
idstringrequired
The unique identifier of the bulk job to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns the bulk job object, including its identifier, state, timestamps, task details, and status URL.
idstringoptional
The unique identifier for the bulk job.
typestringoptional
The type of the object.
Allowed:contacts.bulk.job
statestringoptional
The current state of the job.
Allowed:pendingrunningcompletedcompleted_with_errors
created_atintegeroptional
The time the job was created as a Unix timestamp.
updated_atintegeroptional
The time the job was last updated as a Unix timestamp.
completed_atintegeroptional
The time the job completed as a Unix timestamp. Null if not yet completed.
tasksarray<object>optional
The tasks that make up this bulk job.
urlstringoptional
The URL to check the job status.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. The id path parameter must identify the bulk job whose status you want to retrieve.