---
id: suggestion-read
title: "Read a suggestion"
description: "Get a single suggestion by ID."
sidebar_label: "Read a suggestion"
hide_title: true
hide_table_of_contents: true
api: eJzFWFlz4zYS/isovCSpIiX6mCTDN6/HmziVY8pHkl1LJUNEk0RMAhwcshUV//tWA5RESsr4SKX2RaJEoM+vzxXlYDItGiuUpCn9DixhxAhZVECMKwow+IbMl+Tyw4hGVDWgGf51yWlKtydSDYzTiFpWGJre0evNGzqNqIHMaWGXNL1b0TkwDfrM2ZKmd9N2GtGGaVaDBW38AYGSNMyWNKKS1UBTyjLP00J9iVxMVkLNaLqidtnge2O1kAVtI6rhkxMaOE2tdhDt6HdTAgm0iLBQd0rBE6ubCuk8/efPb759fzY/5xc5baODsoi/LUHPsLsCmNvi6PhkLcAUqZlGSQMGeR0nCX59jiKSy5S0IC0eZU1Ticx7bPyHwfOrfdnV/A/ILI1oo9G/VgRugu/rd0gdJ8Un9wqtImoqVzxP+8xZFRcgEXHAye3Vj3GuBUheLQlSGPJwDWcWYq6yB9C5qCCeMwOxqFkByDO4fYZun71Us4ZpkPY1iKHGMuvMIfIgXY2h0YDk4R/WNFotgIfHSvinnInKP2hAr/hHeGo8oqaHhMyc9lIGzkPp1rzaiGYa0Iyz+fJlurMCidqSWdJdJXYPaT0XdyEem4xJCTr295GxepSgX8NTaWKWBo3tuT+KqiLwBJmz4EXIxdOQt/dxHADQY5wpmQsOMoMed+nqOeg97uebs8RkSgOZg30EkCQhTHJyNGCYjN4ftzsUngUz6f0mKveaYLwpA9yrRK5d0yhtDfmJ6QeuHncsfOv18/c+bEBOEOTEG4BYRTQYVS2AnP96ER8nx1/HR8cnpyM0Rg2WcWYPhv1Q0p9YVgoJsVVxHR7J+jLJlfYCBHcoPZBwRTU0ygir9BLJ62JcL2PWiNiAXogMaETnmsmspCnNxdM4W8BWStq2EXUG9Ozlon7vaiZj4MKyeeXDtasjO3JZpguwswVoEy4eJzGrGiHhZHT0fp/zzEOneF6AH65/+Zlc+3zqbaNBckD/k/sBwXsipDfc7aX3RrAf5iMNxlX2eU5X/hwCh/Uz7YbQaC99G5dlYPqpaK5UBUzu0f6tBFtC37NI2t8HDnxgTKxpHk7GYGJ9Ae6Nq2uml6S7MgT1v7bwDfHLSSd37qpq6Y3FwTJRmedtdMa5wEdWke5OhNRKwgxhpBLyAWMEtQxWRz99vNrBSuOqaoY1HIylKS2tbUw6HhfClm4+ylQ93gf2GC+NT49pi1CywnrdLtamDL7b+h34jNlDpsuVrvENRUvsqfcBw/+xBLmTiMkjM+sEOXSWdFXVrsuHeRPTC7zr+weC74fe88GbvIuP3vUrzAvYxFbU+7zOkQBywrfGsro5xO40Tr6+OTpOT5I0SUZJkvwXmXfoeTvzH5mxHQZfz7/n9V7n23o4nP7++37Tdl4JLHWgtc8aXY9HuPNpXMgFqwQnQjbORqQWBlvyXn6LsEg6yZwtlRZ/AifMB81oIifyKoCXeBrBoJ6PIc4AYYSLPIfQMpSsgXQi7+/vsTmcyNVEEjLx5pvQlEzorxsaF0hiQqNwIhDEM3crMlmng3BnrviS1M5YUrIFxlroh0mXnpbkCw456JmTVlRfTChppxPZeikm8jXtq5LwS+5Hhs/nhWvLJGea75h7RPvN+l3Xup0rjuDwR+k20U330uv29BZwQlooDrQX39/cfOwaNJIpDuRLGBWjiJwmCX4c4ccJfpx+NYDcaZL4Roa/INOu6zZOYr4cBm3x8hDGc8Y3Ca5da/os+etSaXuoiQls8PJuaufkasvm5RVjL4sTNlfObpkN+dyUAWMIecyENasw3IETr720TEjgm5jqNwkYn88X3sPR9Jcw8uQ6s5p93ARuB8aDjUI7MbfxUb8CMq3ZkkYUZ5KDlXHI9DPG7+Hi2bgNEevzWttOQ3p7dyi9XYNegN5Lb0JyH82yIEwSYYwDokI5O/t4SYwIUH3z/Pr/imYNjQYD0mvmi3MDmchFRkzPEAPYvntFZJ+R+q9juxvRmIXClwITBAh8cZh0eicwUS0tWTULh2YwQNlLxJlrAXlESt9+b2R6RW647EQgHVA2QP/HssSZJE7CU+NH6k4ulfnZma8xGOwx6vAdhqZS4aKrAB9TuAdK6bi3Shiv+qupdrztysx4JXiLqyJPNay2nK56PSVrxAhbtKZiFlMWdpd+6bMepv1kEQDa35ptbIOE1ssoH8H+EI5Z/uHf667nh99ufI8iZK7w+nYQOholo4Ruu5ezsOq49GmljWijjK2ZD7tu/XUFjA9mkF3XrLbx+/w+sVPEwpMdNxUT0vdyaKVVZ+67/uaGRjTd3QVuLY5vhd+SlAqb9zu6WuF8fKurtsW/PznA0fRuGtEF0wJR693ChcFnTtOcVWZ3Z9dX6MurLsV8RQ7vEg8qtE7aElP2glUOf9GIPsByd7mJBenN4uyt4N4gjeC0nbYRLYFx3NvcrboXZ1kGje1d2cvNCN1NyHx3cYN7rSFgdwDa792G4qxW4cSNegDZthvpLP6mvvb8Dwlj2iE=
sidebar_class_name: "get api-method"
info_path: docs/api/action-items
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read a suggestion"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/action_item/{actionItemId}/suggestions/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Get a single suggestion by ID.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"actionItemId","schema":{"type":"string"},"required":true,"description":"The action item ID.","example":"xYz789AbCdEf"},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The suggestion ID.","example":"sUg123AbCdEf"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The suggestion.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique suggestion ID.","example":"sUg123AbCdEf"},"slug":{"type":"string","description":"Auto-generated URL-friendly slug.","example":"update-dockerfile-base-image"},"action_item_id":{"type":"string","description":"The parent action item ID.","example":"xYz789AbCdEf"},"status":{"type":"string","enum":["pending","approved","applied","failed","rejected","expired"],"description":"The current status.","example":"pending"},"created_by":{"type":"string","description":"The agent that created the suggestion.","example":"security-scanner-agent"},"owner":{"type":"string","description":"The agent or system that will execute the fix.","example":"image-updater-agent"},"confidence":{"type":"number","description":"Confidence score between 0 and 1.","example":0.92},"description":{"type":"string","description":"A description of the proposed fix. Supports Markdown.","example":"Update the Dockerfile base image to resolve CVE-2026-1234."},"metadata":{"type":"object","description":"Machine-to-machine metadata for the executor.","example":{"repository":"org/my-api-service","branch":"fix/cve-2026-1234"}},"user_metadata":{"type":"object","description":"Human-editable parameters.","example":{"target_version":"20-alpine3.19"}},"user_metadata_config":{"type":"object","description":"JSON Schema for rendering `user_metadata` in the UI."},"execution_result":{"type":"object","description":"Result of a suggestion execution.","properties":{"success":{"type":"boolean","description":"Whether the execution succeeded.","example":true},"message":{"type":"string","description":"A summary message.","example":"Base image updated successfully."},"details":{"type":"object","description":"Additional details, such as a link to the resulting PR.","example":{"pull_request":"https://github.com/org/my-api-service/pull/42"}}},"title":"ExecutionResult"},"executed_at":{"type":"string","format":"date","description":"Date when the suggestion was executed.","example":null},"expires_at":{"type":"string","format":"date","description":"Expiration date.","example":"2026-05-15"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp.","example":"2026-04-06T12:30:00.000Z"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp.","example":"2026-04-06T12:30:00.000Z"}},"title":"Suggestion"}}}},"4XX":{"description":"Client error responses due to invalid input, missing parameters, or unauthorized access.\n\nRequest validation errors use a different shape:\n```json\n{\n  \"type\": \"ValidationError\",\n  \"errors\": [{ \"message\": \"body must have required property 'defer_until'\" }]\n}\n```\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Standard error response.","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"Machine-readable error code.","example":"bad_request"},"error":{"type":"string","description":"Short description of the error type.","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}},{"type":"object","description":"Request validation error response.","required":["type","errors"],"properties":{"type":{"type":"string","example":"ValidationError"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"body must have required property 'until'"}}}}}}]}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error.","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type.","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred on the server."}}}}}}}}
>
  
</StatusCodes>