---
title: List GitHub issues
source: https://docs.newrelic.com/docs/workflow-automation/setup-and-configure/actions-catalog/github/github-issue-list
---

Lists issues in a GitHub repository with optional filtering by state, labels, assignee, and milestone.

For authentication setup, see [GitHub issue actions](https://docs.newrelic.com/docs/workflow-automation/setup-and-configure/actions-catalog/github/github-issue).

## Inputs

The following inputs are available for this action.

| Input Field          | Optionality | Type   | Description                                                                                                                                                                                                                                                              | Example                                                       |
| -------------------- | ----------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- |
| **token**            | Required    | String | GitHub Personal Access Token (fine-grained or classic) stored as a secret. Fine-grained PATs require Issues: Read and write permission. Classic PATs require repo scope.                                                                                                 | `"${{ :secrets:github-PAT-token }}"`                          |
| **owner**            | Required    | String | The account owner of the repository (user or organization login). Case-insensitive.                                                                                                                                                                                      | `"octocat"`                                                   |
| **repo**             | Required    | String | Repository name without the .git suffix. Case-insensitive.                                                                                                                                                                                                               | `"Hello-World"`                                               |
| **milestone**        | Optional    | String | Filter by milestone. Pass a milestone number to filter by that milestone, `*` for issues with any milestone, or `none` for issues without a milestone.                                                                                                                   | `"1"` or `"*"` or `"none"`                                    |
| **state**            | Optional    | String | Filter by issue state. Default: `open`. Allowed values: `open`, `closed`, `all`.                                                                                                                                                                                         | `"open"`                                                      |
| **assignee**         | Optional    | String | Filter by assignee username, `none` for unassigned issues, or `*` for issues assigned to any user.                                                                                                                                                                       | `"octocat"`                                                   |
| **type**             | Optional    | String | Filter by issue type name, `*` for issues with any type, or `none` for issues without a type.                                                                                                                                                                            | `"Bug"`                                                       |
| **creator**          | Optional    | String | Filter by the user that created the issue.                                                                                                                                                                                                                               | `"octocat"`                                                   |
| **mentioned**        | Optional    | String | Filter by a user mentioned in the issue.                                                                                                                                                                                                                                 | `"octocat"`                                                   |
| **labels**           | Optional    | String | Comma-separated list of label names to filter by.                                                                                                                                                                                                                        | `"bug,incident"`                                              |
| **sort**             | Optional    | String | Sort results by field. Default: `created`. Allowed values: `created`, `updated`, `comments`.                                                                                                                                                                             | `"created"`                                                   |
| **direction**        | Optional    | String | Sort direction. Default: `desc`. Allowed values: `asc`, `desc`.                                                                                                                                                                                                          | `"desc"`                                                      |
| **since**            | Optional    | String | Filter to issues last updated after this time. Must be an ISO 8601 timestamp: `YYYY-MM-DDTHH:MM:SSZ`.                                                                                                                                                                    | `"2024-01-01T00:00:00Z"`                                      |
| **perPage**          | Optional    | Int    | Number of results per page (maximum 100). Default: `30`.                                                                                                                                                                                                                 | `30`                                                          |
| **page**             | Optional    | Int    | Page number of the results to fetch. Default: `1`.                                                                                                                                                                                                                       | `1`                                                           |
| **issueFieldValues** | Optional    | List   | Issue field values for GitHub Projects v2 custom fields. Each object must include `field_id` (integer) and `value` (string, number, or array for multi-select fields). Only available for organization-owned repositories with GitHub Projects v2 custom fields enabled. | `[{"field_id": 1, "value": "high"}]`                          |
| **selectors**        | Optional    | List   | JQ selectors to extract values from the response.                                                                                                                                                                                                                        | `[{"name": "firstIssueNumber", "expression": ".[0].number"}]` |

## Outputs

This action returns the following outputs.

| Output Field     | Type    | Example                                                                                                                                                                                                                                                                                                           |
| ---------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **response**     | Array   | ```yaml [   {     "id": 1,     "number": 1347,     "state": "open",     "title": "Found a bug",     "html_url": "https://github.com/octocat/Hello-World/issues/1347",     "body": "I'm having a problem with this.",     "created_at": "2011-04-22T13:33:48Z",     "updated_at": "2011-04-22T13:33:48Z"   } ] ``` |
| **success**      | Boolean | `success: true | false`                                                                                                                                                                                                                                                                                           |
| **errorMessage** | String  | Contains the GitHub API error response body.                                                                                                                                                                                                                                                                      |

## Example

| Workflow example                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ```yaml name: github_list_issues_workflow description: List open GitHub issues steps:   - name: list_issues     type: action     action: gitHub.issue.list     version: 1     inputs:       token: ${{ :secrets:github-PAT-token }}       owner: your_user_name       repo: test-workflow       state: open       assignee: your_user_name       labels: "incident"       sort: created       direction: desc       perPage: 30       page: 1     next: end ``` |