Skip to content
forgit api docs

List jobs of a workflow run

GET
/repos/{owner}/{repo}/actions/runs/{run_id}/jobs

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

run_id
required
integer format: int64

ID of the workflow run

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

ActionRunJobList

Media type application/json
Array<object>

ActionRunJob represents a job of a run

object
attempt

How many times the job has been attempted including the current attempt.

integer format: int64
handle

Opaque identifier that uniquely identifies a single attempt of a job.

string
id

Identifier of this job.

integer format: int64
name

The action run job name

string
needs

The action run job needed ids

Array<string>
owner_id

The owner id

integer format: int64
repo_id

The repository id

integer format: int64
run_id

Identifier of the workflow run this job belongs to.

integer format: int64
runs_on

The action run job labels to run on

Array<string>
status

The action run job status

string
task_id

The action run job latest task id

integer format: int64
Example generated 
[
  {
    "attempt": 1,
    "handle": "example",
    "id": 1,
    "name": "example",
    "needs": [
      "example"
    ],
    "owner_id": 1,
    "repo_id": 1,
    "run_id": 1,
    "runs_on": [
      "example"
    ],
    "status": "example",
    "task_id": 1
  }
]

400

Section titled “ 400 ”

APIError is error format response

Media type application/json

APIError is an api error with a message

object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

403

Section titled “ 403 ”

APIForbiddenError is a forbidden error response

Media type application/json
object
message
string
url
string
Example generated 
{
  "message": "example",
  "url": "example"
}

404

Section titled “ 404 ”

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}