Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Knowledge Manager → Get Suggestion

AI-generated

Summary

Retrieve a specific Suggestion resource by its unique identifier within a specified Yext account, optionally formatting rich text fields.

Inputs

  • Account Id (required) — The identifier of the Yext account containing the Suggestion.
  • Suggestion Uid (required) — The Yext-generated unique identifier for the Suggestion.
  • V (required) — The API version date in YYYYMMDD format.
  • Format — Format to parse rich text field values; valid options are 'markdown', 'html', or 'none'. Defaults to 'markdown'.

Output shape

a single Suggestion object as returned by the Yext Knowledge API

The output is a single Suggestion resource JSON object. Rich text fields will be parsed according to the 'Format' parameter if applicable. Request supports additional options like batching, proxy, timeout, and SSL certificate ignoring, but these do not affect output shape.

Discussion