checkSuggestion
Check a suggestion
Read the status of an improvement suggestion by its id (sug_...) or its short reference (FEEDBACK-012). Dispositions: received, watch, in-progress, shipped-canary, shipped-fleet, already-covered, refuted, held. A member sees only suggestions filed by its own connection.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
id | string | required | The id or the FEEDBACK reference returned by suggestImprovement |
Scopes
None. Any authenticated connection can call it.
Annotations
- Read only: yes
- Destructive: no
When to use
Use checkSuggestion in a later session to see what happened to a suggestion you filed with suggestImprovement. Pass its id (sug_ and 24 hexadecimal characters) or its short reference (FEEDBACK-012). A person can read the reference out to you; letter case and leading zeros do not matter. The numbers count every suggestion filed on this instance.
It needs no scope. Any authenticated connection can call it.
- A member's connection sees only the suggestions that the same connection filed.
- An admin or staff connection sees any suggestion on the instance.
disposition is one of these values:
received: filed, not yet reviewed.watch: one vote so far.in-progress: a change is being made.shipped-canary: fixed, and running on the canary instance.shipped-fleet: fixed, and running here.already-covered: a tool already does this.dispositionNotenames it.refuted: the cause was not what the suggestion said.dispositionNotesays what was true.held: waiting on a decision.
severity, dispositionNote, pr and liveVersion are null when they have no value.
Example
{ "id": "FEEDBACK-012" }
{
"id": "sug_4f1c9a2e7b3d5a6c8e0f1b2d",
"ref": "FEEDBACK-012",
"kind": "feature",
"severity": "minor",
"summary": "searchKnowledge should return every matching line in a file, not only the first",
"disposition": "shipped-canary",
"dispositionNote": "Added an option to return more than one line for each file.",
"pr": "#800",
"liveVersion": "v1.0.1500",
"createdAt": "2026-10-02T10:41:07.233Z",
"updatedAt": "2026-10-03T08:15:52.019Z"
}
Refusals and what to do
Error in checkSuggestion: Suggestion not found: no suggestion has that id or reference, or a member's connection asked for a suggestion that another connection filed. The two cases give the same answer. Use theidorrefthatsuggestImprovementreturned to this connection, or find it withlistSuggestions.- An
idthat is neithersug_followed by 24 lowercase hexadecimal characters norFEEDBACK-followed by 1 to 9 digits is refused as invalid arguments.
Related
suggestImprovementfiles a suggestion and returns itsidandref.listSuggestionslists the suggestions this connection can see.getDocswith theimprovementssection lists the recent suggestions that this connection can see.