list-issues-for-a-repository.json

{
  "name": "List issues for a repository",
  "enabledForApps": true,
  "method": "GET",
  "path": "/repos/:owner/:repo/issues",
  "params": [
    {
      "name": "owner",
      "type": "string",
      "required": true,
      "description": ""
    },
    {
      "name": "repo",
      "type": "string",
      "required": true,
      "description": ""
    },
    {
      "name": "milestone",
      "type": "integer or string",
      "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.",
      "required": false
    },
    {
      "name": "state",
      "type": "string",
      "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
      "default": "open",
      "required": false
    },
    {
      "name": "assignee",
      "type": "string",
      "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.",
      "required": false
    },
    {
      "name": "creator",
      "type": "string",
      "description": "The user that created the issue.",
      "required": false
    },
    {
      "name": "mentioned",
      "type": "string",
      "description": "A user that's mentioned in the issue.",
      "required": false
    },
    {
      "name": "labels",
      "type": "string",
      "description": "A list of comma separated label names. Example: `bug,ui,@high`",
      "required": false
    },
    {
      "name": "sort",
      "type": "string",
      "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
      "default": "created",
      "required": false
    },
    {
      "name": "direction",
      "type": "string",
      "description": "The direction of the sort. Can be either `asc` or `desc`.",
      "default": "desc",
      "required": false
    },
    {
      "name": "since",
      "type": "string",
      "description": "Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "required": false
    },
    {
      "name": "per_page",
      "type": "number",
      "required": false,
      "description": "Results per page (max 100)",
      "default": 30
    },
    {
      "name": "page",
      "type": "number",
      "required": false,
      "description": "Page number of the results to fetch.",
      "default": 1
    }
  ],
  "description": "**Note**: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint may also return pull requests in the response. If an issue _is_ a pull request, the object will include a `pull_request` key.\n\n\n\n**Note:** If a user opened an issue via a GitHub App, the `performed_via_github_app` key contains information on that GitHub App.",
  "documentationUrl": "https://developer.github.com/v3/issues/#list-issues-for-a-repository"
}