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

Response Example: 200 application/json

{
  "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
  "completed_at": "2020-01-20T17:44:39Z",
  "conclusion": "success",
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
  "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
  "id": 399444496,
  "name": "build",
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
  "run_id": 29679449,
  "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449",
  "started_at": "2020-01-20T17:42:40Z",
  "status": "completed",
  "steps": [
    {
      "completed_at": "2020-01-20T09:42:41.000-08:00",
      "conclusion": "success",
      "name": "Set up job",
      "number": 1,
      "started_at": "2020-01-20T09:42:40.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:42:45.000-08:00",
      "conclusion": "success",
      "name": "Run actions/checkout@v2",
      "number": 2,
      "started_at": "2020-01-20T09:42:41.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:42:45.000-08:00",
      "conclusion": "success",
      "name": "Set up Ruby",
      "number": 3,
      "started_at": "2020-01-20T09:42:45.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:42:48.000-08:00",
      "conclusion": "success",
      "name": "Run actions/cache@v2",
      "number": 4,
      "started_at": "2020-01-20T09:42:45.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:42:52.000-08:00",
      "conclusion": "success",
      "name": "Install Bundler",
      "number": 5,
      "started_at": "2020-01-20T09:42:48.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:42:53.000-08:00",
      "conclusion": "success",
      "name": "Install Gems",
      "number": 6,
      "started_at": "2020-01-20T09:42:52.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:42:59.000-08:00",
      "conclusion": "success",
      "name": "Run Tests",
      "number": 7,
      "started_at": "2020-01-20T09:42:53.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:44:39.000-08:00",
      "conclusion": "success",
      "name": "Deploy to Heroku",
      "number": 8,
      "started_at": "2020-01-20T09:42:59.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:44:39.000-08:00",
      "conclusion": "success",
      "name": "Post actions/cache@v2",
      "number": 16,
      "started_at": "2020-01-20T09:44:39.000-08:00",
      "status": "completed"
    },
    {
      "completed_at": "2020-01-20T09:44:39.000-08:00",
      "conclusion": "success",
      "name": "Complete job",
      "number": 17,
      "started_at": "2020-01-20T09:44:39.000-08:00",
      "status": "completed"
    }
  ],
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

job_id *

job_id parameter

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/actions/jobs/{job_id}