Skip to main content
GET
Get job status by ID

Retrieving a Job Status

This endpoint allows you to retrieve the status of a job.

Path Parameters

Response Structure

The response includes comprehensive details about the job, including:
  • Basic job details (ID, name, status)
  • Timing information (createdAt, updatedAt)
  • Job provider information
  • Workspace association
  • Error details (if applicable)
The response object includes the following fields:

Authorizations

Authorization
string
header
required

Bearer token issued for an authenticated Oration user or service account.

Headers

x-api-key
string
required

Workspace API key used for server-to-server authentication.

x-workspace-slug
string
required

Workspace slug associated with the job.

x-workspace-id
string

Workspace UUID. Useful when the workspace slug is not available.

Path Parameters

id
string
required

Job UUID returned by an async endpoint such as /customers/batch.

Response

Job status returned successfully.

Current status of an asynchronous job.

id
string<uuid>
required

Job identifier.

createdAt
string
required

Timestamp when the job was created.

updatedAt
string
required

Timestamp when the job status last changed.

jobProviderId
string<uuid>
required

Identifier used by the underlying job provider or queue backend.

name
string
required

Internal job name for the asynchronous task.

status
enum<string>
required

Current execution state of the job.

Available options:
created,
queued,
active,
success,
failed,
retrying
error
string | null
required

Error message when the job fails; otherwise null.

workspaceId
string<uuid>
required

Workspace that owns the job.