List repository milestones | GitHub API (unofficial showcase)

7 parameters

ownerstringrequired

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

repostringrequired

The repository name without the `.git` extension; the name is not case sensitive.

statestringoptional

Filter milestones by state: `open`, `closed`, or `all`. Defaults to open when omitted.

Allowed:openclosedallDefault:open

sortstringoptional

Sort results by `due_on` or `completeness`. Defaults to due_on when omitted.

Allowed:due_oncompletenessDefault:due_on

directionstringoptional

Sort direction: `asc` or `desc`. Defaults to asc when omitted.

Allowed:ascdescDefault:asc

per_pageintegeroptional

Number of results per page, up to 100. Defaults to 30 when omitted.

Default:30

pageintegeroptional

Page number of the results to fetch. Defaults to 1 when omitted.

Default:1

2 status codes

200Returns an array of milestone objects, including each milestone's number, state, title, description, due date, and issue counts.

urlstringrequired

html_urlstringrequired

labels_urlstringrequired

idintegerrequired

node_idstringrequired

numberintegerrequired

The number of the milestone.

statestringrequired

The state of the milestone.

Allowed:openclosedDefault:open

titlestringrequired

The title of the milestone.

descriptionstringrequired

creatorobjectrequired

A GitHub user.

open_issuesintegerrequired

closed_issuesintegerrequired

created_atstringrequired

updated_atstringrequired

closed_atstringrequired

due_onstringrequired

404Returned when the repository is not found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the repository identified by the owner and repo path parameters is not found. state must be open, closed, or all; sort must be due_on or completeness, and direction must be asc or desc. per_page accepts at most 100 results.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.milestones.list({
  owner: "octocat",
  repo: "hello-world",
  state: "example",
  sort: "example",
  direction: "example",
});

[
  {
    "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
    "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0",
    "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels",
    "id": 1002604,
    "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==",
    "number": 1,
    "state": "open",
    "title": "v1.0",
    "description": "Tracking milestone for version 1.0",
    "creator": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "open_issues": 4,
    "closed_issues": 8,
    "created_at": "2011-04-10T20:09:31Z",
    "updated_at": "2014-03-03T18:58:10Z",
    "closed_at": "2013-02-12T13:22:01Z",
    "due_on": "2012-10-09T23:39:01Z"
  }
]

Request

Response

Errors