Interface IssuesParams

Query parameters for listing issues.

Works for both per-repository (GET /repos/{owner}/{repo}/issues) and cross-repository (GET /issues) endpoints. The filter field is only meaningful for the cross-repository endpoint.

See

interface IssuesParams {
    assignee?: string;
    creator?: string;
    direction?: "asc" | "desc";
    filter?:
        | "all"
        | "created"
        | "mentioned"
        | "assigned"
        | "subscribed"
        | "repos";
    labels?: string;
    mentioned?: string;
    milestone?: string
    | number;
    page?: number;
    per_page?: number;
    since?: string;
    sort?: "created" | "updated" | "comments";
    state?: "all" | "open" | "closed";
}

Hierarchy (View Summary)

Properties

assignee? creator? direction? filter? labels? mentioned? milestone? page? per_page? since? sort? state?

Properties

Optionalassignee

assignee?: string

Filter by assignee login, '*' (any), or 'none'

Optionalcreator

creator?: string

Filter by author login

Optionaldirection

direction?: "asc" | "desc"

Sort direction

Optionalfilter

filter?: "all" | "created" | "mentioned" | "assigned" | "subscribed" | "repos"

Which issues to show. Only applies to the cross-repository GET /issues endpoint. Ignored by the per-repository endpoint.

Optionallabels

labels?: string

Filter by comma-separated label names

Optionalmentioned

mentioned?: string

Filter by user mentioned

Optionalmilestone

milestone?: string | number

Filter by milestone number, '*' (any), or 'none'

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

Optionalsince

since?: string

Only return issues updated after this ISO 8601 date

Optionalsort

sort?: "created" | "updated" | "comments"

Sort field

Optionalstate

state?: "all" | "open" | "closed"

Filter by state

Settings

Member Visibility

On This Page

Properties