# List repository workflows

From **GitHub v3 REST API**.

`GET /repos/{owner}/{repo}/actions/workflows`

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.

## Parameters

### `owner`

- Location: path
- Required: true
- Type: `string`

### `repo`

- Location: path
- Required: true
- Type: `string`

### `per_page`

- Location: query
- Required: false
- Type: `integer`
- Default: `30`

Results per page (max 100)

### `page`

- Location: query
- Required: false
- Type: `integer`
- Default: `1`

Page number of the results to fetch.

## Responses

### `200`

Response

#### Headers

##### `Link`

- Type: `string`

- Example: `<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"`

### `application/json`

- Type: `object`

```json
{
  "total_count": 2,
  "workflows": [
    {
      "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg",
      "created_at": "2020-01-08T23:48:37.000-08:00",
      "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335",
      "id": 161335,
      "name": "CI",
      "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=",
      "path": ".github/workflows/blank.yaml",
      "state": "active",
      "updated_at": "2020-01-08T23:50:21.000-08:00",
      "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335"
    },
    {
      "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg",
      "created_at": "2020-01-08T23:48:37.000-08:00",
      "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289",
      "id": 269289,
      "name": "Linter",
      "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==",
      "path": ".github/workflows/linter.yaml",
      "state": "active",
      "updated_at": "2020-01-08T23:50:21.000-08:00",
      "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289"
    }
  ]
}
```

```json
{"properties":{"total_count":{"type":"integer"},"workflows":{"items":{"$ref":"#/components/schemas/workflow"},"type":"array"}},"required":["total_count","workflows"],"type":"object"}
```

## Request examples

### cURL

```shell
curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/actions/workflows
```
