Skip to main content
Manja / GitHub

Get a job for a workflow run

Gets a specific job in 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.

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

Request

Path Parameters
owner string
required
repo string
required
job_id integer
required

job_id parameter

Responses

application/json Job object

Response

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.

items object
completed_at string<date-time>
optionalnullable

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

name string
required

The name of the job.

Example: test-coverage

number integer
required

Example: 1

started_at string<date-time>
optionalnullable

The time that the step 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"

url string
required

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