Yext Knowledge APIInstall

Summary

Retrieve a language-specific profile of an entity from the Yext Knowledge Manager by specifying the account ID, entity ID, and language code, optionally customizing the output format and included fields.

Inputs

• Account Id (required) — The unique identifier of the Yext account to query.
• Entity Id (required) — The external ID of the entity whose language profile is requested.
• Language Code (required) — The language code representing the desired language version of the profile.
• V (required) — Date version in YYYYMMDD format to specify the API version.
• Convert Markdown To HTML — Optional flag to convert Markdown fields to HTML (true) or return as JSON (false).
• Convert Rich Text To HTML — Optional flag to convert Rich Text fields to HTML (true) or return as JSON (false).
• Fields — Comma-separated list of specific fields to return, supporting dot notation for nested fields and custom fields with 'c_*' prefix.
• Format — Format to use for Legacy Rich Text fields when present: 'markdown', 'html', or 'none'.
• Rendered — Boolean to control whether to return only language-specific fields (false) or the full profile including language-independent data (true).

Output shape

a single JSON object representing the language profile data of the specified entity

Response fields may vary based on optional parameters like 'Fields', 'Rendered', and formatting options for Markdown and Rich Text fields; only one entity's profile is returned per execution.