Intercom API (unofficial showcase)
GET/jobs/status/{job_id}

Retrieve job status

Retrieves the execution status and result details for an asynchronous job. Use the job_id provided by Intercom to check whether the job is pending, successful, or failed. When the job creates a resource, the response can include its type, identifier, and URL.

2 parameters
job_idstringrequired
The unique identifier for the job, provided by Intercom.
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted; supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the job object, including its identifier, status, and resource type, identifier, and URL when available.
typestringoptional
The type of the object
Allowed:job
idstringrequired
The id of the job that's currently being processed or has completed.
urlstringoptional
API endpoint URL to check the job status.
statusstringoptional
The status of the job execution.
Allowed:pendingsuccessfailed
resource_typestringoptional
The type of resource created during job execution.
resource_idstringoptional
The id of the resource created during job execution (e.g. ticket id)
resource_urlstringoptional
The url of the resource created during job exeuction. Use this url to fetch the resource.
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
404Returned when the job cannot be found.

One documented failure

  • job_not_found

    Job Not Found

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. A 404 is returned when the job cannot be found. The job_id path parameter must be the unique identifier provided by Intercom.