List milestones

GET/repos/{owner}/{repo}/milestones

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required

Query Parameters

state string optional: The state of the milestone. Either `open`, `closed`, or `all`.
sort string optional: What to sort results by. Either `due_on` or `completeness`.
direction string optional: The direction of the sort. Either `asc` or `desc`.
per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.

Responses

application/json array[Milestone object]

Response

Headers

Link string

Example:

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

items Milestone object

A collection of related issues and pull requests.

closed_at string<date-time>

requirednullable

Example: 2013-02-12T13:22:01Z

closed_issues integer

required

Example: 8

created_at string<date-time>

required

Example: 2011-04-10T20:09:31Z

creator Simple User object

requirednullable

Simple User

avatar_url string<uri>

required

Example: https://github.com/images/error/octocat_happy.gif

email string

optionalnullable

events_url string

required

Example: https://api.github.com/users/octocat/events{/privacy}

followers_url string<uri>

required

Example: https://api.github.com/users/octocat/followers

following_url string

required

Example: https://api.github.com/users/octocat/following{/other_user}

gists_url string

required

Example: https://api.github.com/users/octocat/gists{/gist_id}

gravatar_id string

requirednullable

Example: 41d064eb2195891e12d0413f63227ea7

html_url string<uri>

required

Example: https://github.com/octocat

id integer

required

Example: 1

required

Example: octocat

name string

optionalnullable

node_id string

required

Example: MDQ6VXNlcjE=

organizations_url string<uri>

required

Example: https://api.github.com/users/octocat/orgs

received_events_url string<uri>

required

Example: https://api.github.com/users/octocat/received_events

repos_url string<uri>

required

Example: https://api.github.com/users/octocat/repos

site_admin boolean

required

starred_at string

optional

Example: "2020-07-09T00:17:55Z"

starred_url string

required

Example: https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url string<uri>

required

Example: https://api.github.com/users/octocat/subscriptions

type string

required

Example: User

url string<uri>

required

Example: https://api.github.com/users/octocat

description string

requirednullable

Example: Tracking milestone for version 1.0

due_on string<date-time>

requirednullable

Example: 2012-10-09T23:39:01Z

html_url string<uri>

required

Example: https://github.com/octocat/Hello-World/milestones/v1.0

id integer

required

Example: 1002604

labels_url string<uri>

required

Example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels

node_id string

required

Example: MDk6TWlsZXN0b25lMTAwMjYwNA==

number integer

required

The number of the milestone.

Example: 42

open_issues integer

required

Example: 4

state string

required

The state of the milestone.

Default: open

Example: open

Allowed: "open""closed"

title string

required

The title of the milestone.

Example: v1.0

updated_at string<date-time>

required

Example: 2014-03-03T18:58:10Z

url string<uri>

required

Example: https://api.github.com/repos/octocat/Hello-World/milestones/1

Response Example: 200 application/json

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

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

state

The state of the milestone. Either `open`, `closed`, or `all`.

sort

What to sort results by. Either `due_on` or `completeness`.

direction

The direction of the sort. Either `asc` or `desc`.

per_page

Results per page (max 100)

page

Page number of the results to fetch.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/milestones