Yext Knowledge APIInstall

Summary

Retrieve a paginated list of entity suggestions from the Yext Knowledge Manager, optionally filtered by entity IDs, UIDs, statuses, and sorted as specified.

Inputs

• Account Id (required) — The identifier of the account whose suggestions are to be listed.
• V (required) — API version date in YYYYMMDD format.
• Format — The formatting language to parse rich text field values; valid options are 'markdown', 'html', or 'none'. Defaults to 'markdown'.
• Entity Ids — Comma-separated list of entity IDs for which to retrieve suggestions. Defaults to all entities in the account if omitted.
• Entity Uids — Comma-separated list of entity UIDs (formerly Yext IDs) to restrict suggestions to. Defaults to all entities if omitted.
• Statuses — Comma-separated list of suggestion statuses to filter by. Possible values include APPROVED, REJECTED, PENDING, CANCELED. Defaults to all statuses.
• Limit — Number of suggestion results to return, defaulting to 10, with a maximum of 50.
• Page Token — Token to retrieve the next page of suggestions if previous response included a 'nextPageToken'.
• Sort By — URL-encoded JSON string specifying sorting field and direction, e.g. [{"lastUpdatedDate": "descending"}]. Supported fields: 'uid' and 'lastUpdatedDate'.

Output shape

A JSON object containing a list of suggestions and pagination tokens when applicable.

Results are paginated; use 'nextPageToken' from the response as 'Page Token' input to fetch subsequent pages. Suggestions correspond to entities and may include filtering by status, entity IDs, or UIDs. The 'format' input affects parsing of rich text fields in the suggestions.