Developer APIResourcesJobs

List jobs from a recipe

Returns aggregated job information as well as detailed job information for a specified recipe in Workato.

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_idintegerRequired
Recipe ID.

Headers

AuthorizationstringRequired

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

Query parameters

offset_job_idstringOptional
Offset job ID or job rerun ID.
prevstringOptional

Defaults to false. set to prev=false, this call returns jobs completed prior to the offset_job_id. If prev=true, jobs newer than the offset_job_id are returned.

statusstringOptional

Filter by status. Options are succeeded, failed, or pending.

rerun_onlystringOptional

If set to true, returns jobs that were rerun only.

offset_job_rerun_idstringOptional
Offset job rerun ID. This parameter has been deprecated.
failedstringOptional

If set to true, returns failed jobs only. This parameter has been deprecated.

Response

Success reply
job_succeeded_countinteger
The count of successfully completed jobs.
job_failed_countinteger
The count of failed jobs.
job_countinteger
The total number of jobs.
itemslist of objects
A list of job details.

Errors