Developer APIResourcesJobs

Get a job

Returns a single job’s metadata by its job handle.

Run-time data is the data that flows through the recipe at the time of job execution. This includes the input and output data from individual steps. This data is available through the Workato platform on the job details page.

Path parameters

recipe_idstringRequired
Recipe ID.
handleintegerRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idstringRequired
Job ID.

Response

Success reply
idstring or null
The unique identifier for the job.
handlestring or null
The unique handle for the job.
recipe_idinteger or null
The ID of the recipe associated with the job.
completed_atstring or null
The timestamp when the job was completed.
started_atstring or null
The timestamp when the job started.
titlestring or null
The title or description of the job.
is_poll_errorboolean or null
Indicates whether a poll error occurred during the job.
lineslist of objects or null
Details about the individual lines executed within the job.
errorstring or null
Error message if the job failed.
is_errorboolean or null
Indicates whether the job resulted in an error.
is_repeatboolean or null
Indicates whether the job is a repeat execution.
is_testboolean or null
Indicates whether the job is a test execution.
is_test_case_jobboolean or null
Indicates whether the job is a test case job.
master_job_idstring or null
The ID of the master job associated with this job.
master_job_handlestring or null
The handle of the master job associated with this job.
statusstring or null
The status of the job.
calling_recipe_idstring or null
The ID of the calling recipe, if applicable.
calling_job_idstring or null
The ID of the calling job, if applicable.
calling_job_handlestring or null
The handle of the calling job, if applicable.

Errors