Skip to main content

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