Skip to main content
Manja / GitHub

List jobs for a workflow run

Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#parameters).

GET/repos/{owner}/{repo}/actions/runs/{run_id}/jobs
Source
github-v3-rest.json
Revision
f5f067c1e6f6
Active snapshot
85e53e3d0d65

Request

Path Parameters
owner string
required
repo string
required
run_id integer
required

The id of the workflow run.

Query Parameters
filter string
optional

Filters jobs by their `completed_at` timestamp. Can be one of: \* `latest`: Returns jobs from the most recent execution of the workflow run. \* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.

per_page integer
optional

Results per page (max 100)

page integer
optional

Page number of the results to fetch.

Responses

application/json object

Response

Headers
Link string
Example:
<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
jobs array[Job object]
required
items Job object

Information of a job execution in a workflow run

check_run_url string
required

Example: https://api.github.com/repos/github/hello-world/check-runs/4

completed_at string<date-time>
requirednullable

The time that the job finished, in ISO 8601 format.

Example: 2019-08-08T08:00:00-07:00

conclusion string
requirednullable

The outcome of the job.

Example: success

head_sha string
required

The SHA of the commit that is being run.

Example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url string
requirednullable

Example: https://github.com/github/hello-world/runs/4

id integer
required

The id of the job.

Example: 21

name string
required

The name of the job.

Example: test-coverage

node_id string
required

Example: MDg6Q2hlY2tSdW40

run_attempt integer
optional

Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.

Example: 1

run_id integer
required

The id of the associated workflow run.

Example: 5

run_url string
required

Example: https://api.github.com/repos/github/hello-world/actions/runs/5

started_at string<date-time>
required

The time that the job started, in ISO 8601 format.

Example: 2019-08-08T08:00:00-07:00

status string
required

The phase of the lifecycle that the job is currently in.

Example: queued

Allowed: "queued""in_progress""completed"

steps array[object]
optional

Steps in this job.

url string
required

Example: https://api.github.com/repos/github/hello-world/actions/jobs/21

total_count integer
required