Skip to main content
GET
/
jobs
/
{id}
Get job status by ID
curl --request GET \
  --url https://www.oration.ai/api/v2/jobs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-slug: <x-workspace-slug>'
{
  "id": "5135bfe3-b2c7-41f3-a44f-f4b58e7384df",
  "createdAt": "2026-04-01T10:16:00.000Z",
  "updatedAt": "2026-04-01T10:18:42.000Z",
  "jobProviderId": "b9eb98d0-2445-46a3-8107-4fcf243f85e4",
  "name": "customer.createBatch",
  "status": "success",
  "error": null,
  "workspaceId": "6f8c7d9d-34e2-4f42-9f5d-8f3c5b16a6af"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oration.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Retrieving a Job Status

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

​
Path Parameters

ParameterTypeDescription
idstring (UUID)The unique identifier of the job you want to retrieve

​
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:
FieldTypeDescription
idstring (UUID)The unique identifier of the job
createdAtstring (ISO date)The timestamp when the job was created
updatedAtstring (ISO date)The timestamp when the job was last updated
jobProviderIdstring (UUID)The identifier of the job provider that processed this job
namestringThe name of the job
statusstringThe current status of the job (created, queued, active, success, failed, retrying)
errorstring or nullError message if the job failed, null otherwise
workspaceIdstring (UUID)The identifier of the workspace this job belongs to

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.