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.

{ "check_run_url": "https://api.github.com/repos/github/hello-world/check-runs/4", "completed_at": "2019-08-08T15:00:00.000Z", "conclusion": "success", "head_branch": "main", "head_sha": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", "html_url": "https://github.com/github/hello-world/runs/4", "id": 21, "labels": [ "self-hosted", "foo", "bar" ], "name": "test-coverage", "node_id": "MDg6Q2hlY2tSdW40", "run_attempt": 1, "run_id": 5, "run_url": "https://api.github.com/repos/github/hello-world/actions/runs/5", "runner_group_id": 2, "runner_group_name": "my runner group", "runner_id": 1, "runner_name": "my runner", "started_at": "2019-08-08T15:00:00.000Z", "status": "queued", "steps": [ { "completed_at": "2019-08-08T15:00:00.000Z", "conclusion": "success", "name": "test-coverage", "number": 1, "started_at": "2019-08-08T15:00:00.000Z", "status": "queued" } ], "url": "https://api.github.com/repos/github/hello-world/actions/jobs/21", "workflow_name": "Build" }

Responses

🟢200Response

application/json

Body

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> | null

required

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

Example:

2019-08-08T15:00:00.000Z

conclusion

enum<string> | enum<null>

required

The outcome of the job.

Allowed values:

successfailureneutralcancelledskippedtimed_outaction_required

Example:

success

head_branch

string | null

required

The name of the current branch.

Example:

main

head_sha

string

required

The SHA of the commit that is being run.

Example:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

html_url

string | null

required

Example:

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

integer

required

The id of the job.

Example:

labels

array[string]

required

Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.

Example:

["self-hosted","foo","bar"]

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:

run_id

integer

required

The id of the associated workflow run.

Example:

run_url

string

required

Example:

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

runner_group_id

integer | null

required

The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)

Example:

runner_group_name

string | null

required

The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)

Example:

my runner group

runner_id

integer | null

required

The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)

Example:

runner_name

string | null

required

The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)

Example:

my runner

started_at

string <date-time>

required

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

Example:

2019-08-08T15:00:00.000Z

status

enum<string>

required

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

Allowed values:

queuedin_progresscompleted

Example:

queued

steps

array [object {6}]

optional

Steps in this job.

completed_at

string <date-time> | null

optional

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

Example:

2019-08-08T15:00:00.000Z

conclusion

string | null

required

The outcome of the job.

Example:

success

name

string

required

The name of the job.

Example:

test-coverage

number

integer

required

Example:

started_at

string <date-time> | null

optional

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

Example:

2019-08-08T15:00:00.000Z

status

enum<string>

required

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

Allowed values:

queuedin_progresscompleted

Example:

queued

url

string

required

Example:

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

workflow_name

string | null

required

The name of the workflow.

Example:

Build

Request

Responses