GitHub API (unofficial showcase)
GET/repos/{owner}/{repo}/issues/{issue_number}/suggestions

List issue suggestions

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.

7 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
issue_numberintegerrequired
The number that identifies the issue.
statestringoptional
Filter suggestions by their state.
Allowed:pendingappliedapproveddismissedreplacedinvalidatedallDefault:pending
actionstringoptional
Filter suggestions by the change they propose.
Allowed:set_typeadd_labeladd_fieldadd_assigneeclose_issue
per_pageintegeroptional
The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:30
pageintegeroptional
The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Default:1

3 status codes
200Response
idintegerrequired
The unique identifier of the suggestion.
issue_idintegerrequired
The unique identifier of the issue the suggestion applies to.
actionstringrequired
The kind of change proposed.
Allowed:set_typeadd_labeladd_fieldadd_assigneeclose_issue
statestringrequired
The suggestion's lifecycle state.
Allowed:pendingappliedapproveddismissedreplacedinvalidated
target_idintegerrequired
The identifier of the target the change applies to (issue type, label, field, assignee, or duplicate issue), when applicable.
target_valuestringrequired
The proposed value, when applicable. An array for multi-select field suggestions.
rationalestringrequired
The rationale the actor provided for the suggestion.
confidencestringrequired
The actor's confidence level in the suggestion.
Allowed:LOWMEDIUMHIGH
actor_idintegerrequired
The unique identifier of the actor that proposed the suggestion.
issue_event_idintegerrequired
The identifier of the timeline event created when the suggestion was approved, when applicable.
resolved_byintegerrequired
The unique identifier of the user who approved or dismissed the suggestion.
created_atstringrequired
The time the suggestion was created.
updated_atstringrequired
The time the suggestion was last updated.
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.