Jobs

List jobs

GEThttps://example.thoughtindustries.com/incoming/v2/jobs/:id

Returns the details of a background job by its unique identifier.

Example request

curl "https://example.thoughtindustries.com/incoming/v2/jobs/:id" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The unique identifier of the background job to retrieve.

Example response

{
  "data": {
    "APIBackgroundJob": {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "description": "string",
      "errorMessage": "string",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "repeatable": true,
      "status": "complete"
    }
  }
}

Response fields

Field	Type	Description
`id`	`uuid`	Unique identifier of the background job.
`type`	`string`	The category or kind of background job.
`description`	`string`	Human-readable summary of what the job does.
`errorMessage`	`string`	Error details if the job failed; empty or absent when the job succeeded.
`createdAt`	`ISO 8601 timestamp`	Date and time the job was created, in ISO 8601 format.
`repeatable`	`boolean`	Indicates whether the job is scheduled to run more than once.
`status`	`BackgroundJobStatus`	Current execution state of the job (e.g., `complete`).