GitHub: List milestones

GitHub issues.issuesListMilestones: arguments, response, policy and SDK examples.

Operation github.issues_list_milestones

Provider route: GET /repos/{owner}/{repo}/milestones. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["issues"]["issuesListMilestones"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issues.issuesListMilestones(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issues.issues_list_milestones(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.owner`	string	Required within parent
`path.repo`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.state`	string	Optional	Default: open One of: open, closed, all
`query.sort`	string	Optional	Default: due_on One of: due_on, completeness
`query.direction`	string	Optional	Default: asc One of: asc, desc
`query.per_page`	integer	Optional	Default: 30
`query.page`	integer	Optional	Default: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	array	Root
`$[]`	Model	Each item	Expand Get a milestone — response body

Referenced models: Get a milestone — response body

Schemas

Get a milestone — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A collection of related issues and pull requests.
`closed_at`	JSON	Required within parent
`closed_at (anyOf 1)`	string	Alternative	Format: date-time
`closed_at (anyOf 2)`	null	Alternative
`closed_issues`	JSON	Required within parent
`closed_issues (anyOf 1)`	integer	Alternative
`closed_issues (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`created_at`	string	Required within parent	Format: date-time
`creator`	Model	Required within parent	Expand Get an issue — response body — user
`description`	JSON	Required within parent
`description (anyOf 1)`	string	Alternative
`description (anyOf 2)`	null	Alternative
`due_on`	JSON	Required within parent
`due_on (anyOf 1)`	string	Alternative	Format: date-time
`due_on (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`labels_url`	string	Required within parent	Format: uri
`node_id`	string	Required within parent
`number`	JSON	Required within parent
`number (anyOf 1)`	integer	Alternative	The number of the milestone.
`number (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`open_issues`	JSON	Required within parent
`open_issues (anyOf 1)`	integer	Alternative
`open_issues (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`state`	string	Required within parent	The state of the milestone. Known values: open, closed Default: open
`title`	string	Required within parent	The title of the milestone.
`updated_at`	string	Required within parent	Format: date-time
`url`	string	Required within parent	Format: uri

Referenced models: Get an issue — response body — user

Get an issue — response body — user

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Get an issue — response body — user A Git Hub user
`$ (anyOf 2)`	null	Alternative

Referenced models: Get an issue — response body — user A Git Hub user

Get an issue — response body — user A Git Hub user

Field	Type	Presence	Description and constraints
`$`	object	Root	A GitHub user.
`avatar_url`	string	Required within parent	Format: uri
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative
`email (anyOf 2)`	null	Alternative
`events_url`	string	Required within parent
`followers_url`	string	Required within parent	Format: uri
`following_url`	string	Required within parent
`gists_url`	string	Required within parent
`gravatar_id`	JSON	Required within parent
`gravatar_id (anyOf 1)`	string	Alternative
`gravatar_id (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`login`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`organizations_url`	string	Required within parent	Format: uri
`received_events_url`	string	Required within parent	Format: uri
`repos_url`	string	Required within parent	Format: uri
`site_admin`	boolean	Required within parent
`starred_at`	string	Optional
`starred_url`	string	Required within parent
`subscriptions_url`	string	Required within parent	Format: uri
`type`	string	Required within parent
`url`	string	Required within parent	Format: uri
`user_view_type`	string	Optional

Policy, approvals and errors

SDK function policy ID: github.issues_list_milestones. Catalog operation: issues/list-milestones. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page