Skip to main content

List Milestones

GET
Retrieve a paginated list of GitHub milestones.

Query Parameters

organization
string
Filter milestones by organization that owns the repository.Example: OWASP
repository
string
Filter milestones by repository name.Example: Nest
state
string
Filter milestones by state.
  • open - Open milestones
  • closed - Closed milestones
ordering
string
Sort results by field. Prefix with - for descending order.
  • created_at - Creation date (ascending)
  • -created_at - Creation date (descending)
  • updated_at - Last update date (ascending)
  • -updated_at - Last update date (descending)
Default: -created_at,-updated_at
page
integer
Page number for pagination. Default: 1
limit
integer
Number of results per page. Default: 100

Response Schema

items
array
Array of milestone objects
count
integer
Total number of milestones matching the filter

Examples

# List all milestones
curl -X GET "https://nest.owasp.org/api/v0/milestones/"

# Filter by organization
curl -X GET "https://nest.owasp.org/api/v0/milestones/?organization=OWASP"

# Filter by repository
curl -X GET "https://nest.owasp.org/api/v0/milestones/?repository=Nest"

# Filter by organization and repository
curl -X GET "https://nest.owasp.org/api/v0/milestones/?organization=OWASP&repository=Nest"

# Filter by state (open milestones only)
curl -X GET "https://nest.owasp.org/api/v0/milestones/?state=open"

# Sort by update date (most recently updated first)
curl -X GET "https://nest.owasp.org/api/v0/milestones/?ordering=-updated_at"

# Combine filters and pagination
curl -X GET "https://nest.owasp.org/api/v0/milestones/?organization=OWASP&state=open&page=1&limit=20"

Get Milestone

GET
Retrieve detailed information about a specific GitHub milestone.

Path Parameters

organization_id
string
required
Organization login/username that owns the repository.Example: OWASP
repository_id
string
required
Repository name.Example: Nest
milestone_id
integer
required
Milestone number.Example: 1

Response Schema

created_at
datetime
ISO 8601 timestamp when the milestone was created
number
integer
Milestone number
state
string
Milestone state: open or closed
title
string
Milestone title
updated_at
datetime
ISO 8601 timestamp when the milestone was last updated
url
string
GitHub URL for the milestone
body
string
Milestone description/body content
closed_issues_count
integer
Number of closed issues in this milestone
due_on
datetime
ISO 8601 timestamp when the milestone is due (null if no due date)
open_issues_count
integer
Number of open issues in this milestone

Error Responses

404 Not Found
object

Examples

# Get milestone by organization, repository, and milestone number
curl -X GET "https://nest.owasp.org/api/v0/milestones/OWASP/Nest/1"

Build docs developers (and LLMs) love