List repository workflows - GitHub v3 REST API

Lists the workflows in a repository. 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.

{ "total_count": 0, "workflows": [ { "badge_url": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg", "created_at": "2019-12-06T14:20:20.000Z", "deleted_at": "2019-12-06T14:20:20.000Z", "html_url": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml", "id": 5, "name": "CI", "node_id": "MDg6V29ya2Zsb3cxMg==", "path": "ruby.yaml", "state": "active", "updated_at": "2019-12-06T14:20:20.000Z", "url": "https://api.github.com/repos/actions/setup-ruby/workflows/5" } ] }

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

total_count

integer

required

workflows

array[object (Workflow) {11}]

required

badge_url

string

required

Example:

https://github.com/actions/setup-ruby/workflows/CI/badge.svg

created_at

string <date-time>

required

Example:

2019-12-06T14:20:20.000Z

deleted_at

string <date-time>

optional

Example:

2019-12-06T14:20:20.000Z

html_url

string

required

Example:

https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml

integer

required

Example:

name

string

required

Example:

node_id

string

required

Example:

MDg6V29ya2Zsb3cxMg==

path

string

required

Example:

ruby.yaml

state

enum<string>

required

Allowed values:

activedeleteddisabled_forkdisabled_inactivitydisabled_manually

Example:

active

updated_at

string <date-time>

required

Example:

2019-12-06T14:20:20.000Z

url

string

required

Example:

https://api.github.com/repos/actions/setup-ruby/workflows/5