Yext Knowledge APIInstall

Summary

Retrieve a specific entity from the Yext Knowledge Manager using the account ID and the entity's external ID, optionally customizing the returned data format and fields.

Inputs

• Account Id (required) — The Yext account ID under which the entity exists.
• Entity Id (required) — The external ID of the requested entity to retrieve.
• V (required) — A date string in YYYYMMDD format indicating the API version date.
• Convert Markdown To HTML — Optional parameter to convert Markdown fields to HTML format; use 'true' to convert, 'false' to return as JSON.
• Convert Rich Text To HTML — Optional parameter to convert Rich Text fields to HTML format; use 'true' to convert, 'false' to return as JSON.
• Fields — Comma-separated list of specific field names to return. Supports dot notation for nested fields and 'c_*' prefix for custom fields.
• Format — Format for Legacy Rich Text fields; valid values are 'markdown' (default), 'html', or 'none'.
• Resolve Placeholders — Boolean to resolve embedded placeholders in Location object fields; 'true' returns resolved values, 'false' returns placeholder labels.

Output shape

a single JSON object representing the requested entity with its fields as specified

The response format and included fields depend on the query parameters provided. Optional parameters affect markdown/rich text conversion and placeholder resolution. The operation requires authentication via Yext API credentials.