issues

List issue suggestions

Changed on

Lists the suggestions on an issue. A suggestion is an agent-proposed change to an issue's type, labels, fields, assignees, or closed state that a maintainer can approve or dismiss.

By default only pending suggestions are returned. Use state=all to return suggestions in every state, or state=<state> to filter to a single state. Use action=<action> to return only suggestions for a specific change.

This endpoint is only available while the issue suggestions feature is enabled for the repository, and only supports issues, not pull requests.

Requires triage access to the repository.

get/repos/{owner}/{repo}/issues/{issue_number}/suggestions

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/suggestions
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

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

issue_numberinteger required

The number that identifies the issue.

Query parameters

state'pending' | 'applied' | 'approved' | 'dismissed' | 'replaced' | 'invalidated' | 'all'

Filter suggestions by their state.

action'set_type' | 'add_label' | 'add_field' | 'add_assignee' | 'close_issue'

Filter suggestions by the change they propose.

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

Response

idinteger required

The unique identifier of the suggestion.

issue_idinteger required

The unique identifier of the issue the suggestion applies to.

action'set_type' | 'add_label' | 'add_field' | 'add_assignee' | 'close_issue' required

The kind of change proposed.

state'pending' | 'applied' | 'approved' | 'dismissed' | 'replaced' | 'invalidated' required

The suggestion's lifecycle state.

target_idinteger nullable required

The identifier of the target the change applies to (issue type, label, field, assignee, or duplicate issue), when applicable.

rationalestring nullable required

The rationale the actor provided for the suggestion.

confidence'LOW' | 'MEDIUM' | 'HIGH' nullable required

The actor's confidence level in the suggestion.

actor_idinteger nullable required

The unique identifier of the actor that proposed the suggestion.

issue_event_idinteger nullable required

The identifier of the timeline event created when the suggestion was approved, when applicable.

resolved_byinteger nullable required

The unique identifier of the user who approved or dismissed the suggestion.

created_atstring date-time required

The time the suggestion was created.

updated_atstring date-time required

The time the suggestion was last updated.

Changes

  • 2022-11-289e668dd7bb04Revision changes
    • warning

      added the new invalidated enum value to the / response property for the response status

    • info

      added the new enum value invalidated to the query request parameter state

  • 2022-11-286fcae87dd7bbRevision changes
    • info

      endpoint added