# Jobs

# List Jobs from a Recipe

Returns aggregated job information as well as detailed job information for a specified recipe in Workato. Run-time data will not be available from this endpoint.

GET /api/recipes/:recipe_id/jobs

# URL Parameters

Name Type Description
recipe_id integer
required
Recipe id.

# Query Parameters

Name Type Description
offset_job_id integer
optional
Offset job ID. Jobs that were done after the this job ID will be returned.
prev boolean
optional
Previous jobs if true, next otherwise.
status string
optional
Filter by status - succeeded, failed or pending.
rerun_only boolean
optional
If true, returns jobs that were rerun only.
offset_run_id integer
(deprecated)
Offset run id. This parameter has been deprecated.
failed boolean
(deprecated)
If true, returns failed jobs only. This parameter has been deprecated.

# Sample request

curl  -X GET 'https://www.workato.com/api/recipes/28904/jobs' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# Response

{
  "job_succeeded_count": 1,
  "job_failed_count": 1,
  "job_count": 1,
  "items": [
    {
      "id": 1004,
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
        "is_poll_error": false,
        "error": null,
        "is_error": false
    },
    {
      "id": 1003,
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "is_poll_error": false,
      "error": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "error_parts": {
        "adapter": "marketo",
        "error_type": "Missing required field",
        "message": "'Filter values' must be present",
        "error_id": "603260f5-a309-45b3-a20e-111d90a28917",
        "error_at": "2020-01-22T01:17:18.021-08:00",
        "input": "<redacted>",
        "inner_message": null
      },
      "is_error": true
    },
  ]
}

# Example of Run-time Data

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.