Yext Knowledge APIInstall

Summary

Retrieve a list of language profiles for a specific entity within a Yext account, optionally filtering by entity types, language codes, and fields, with control over content format rendering.

Inputs

• Account Id (required) — The unique identifier of the Yext account to retrieve language profiles from.
• Entity Id (required) — The external ID of the specific entity whose language profiles are being listed.
• V (required) — The API version date in YYYYMMDD format that governs the endpoint behavior.
• Convert Markdown To HTML — Whether to return Markdown fields as HTML strings (true) or as JSON (false).
• Convert Rich Text To HTML — Whether to return Rich Text fields as HTML strings (true) or as JSON (false).
• Entity Types — A comma-separated string filtering results to only entities matching these types or custom entity API names.
• Fields — Comma-separated list of field names to limit the response to, supporting dot notation for nested fields.
• Format — Format for Legacy Rich Text fields, with valid values markdown, html, or none. Defaults to markdown.
• Language Codes — Comma-separated language codes specifying which language profiles to retrieve.
• Rendered — Boolean string indicating if the full profile (true) or only overridable/language-specific fields (false) should be returned.
• Request Options — Collection of advanced settings including batching, SSL certificate ignoring, proxy usage, and request timeout.

Output shape

a JSON object containing a list of language profiles for the specified entity, with fields and formatting as requested

Response includes profiles filtered and formatted per input query parameters. Pagination details are not declared; request batching can be configured via Request Options for rate control.

Examples

Example 1: Fetch English and French language profiles for a location entity

Set Account Id, Entity Id, V with date; specify Language Codes as 'en,fr', set Entity Types to 'location', and Rendered to 'true' for full profile.