Yext Live API icon

Yext Live API

Interact with Yext Live API

Live API → Get Language Profile

AI-generated

Summary

Retrieve a language-specific profile for a specific entity from a Yext account, optionally filtering fields and formatting content types.

Inputs

  • Account Id (required) — The ID 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 of the profile to retrieve.
  • V (required) — API version date in YYYYMMDD format.
  • Convert Markdown To HTML — Optionally convert Markdown fields to HTML (true) or return as JSON (false).
  • Convert Rich Text To HTML — Optionally convert Rich Text fields to HTML (true) or return as JSON (false).
  • Fields — Comma-separated list of specific fields (including subfields with dot notation) to return.
  • Format — Format for fields of type 'Legacy Rich Text', valid values are 'markdown', 'html', or 'none'.

Output shape

a single JSON object representing the language profile of the specified entity, potentially filtered and formatted according to parameters

The output reflects the retrieved language profile for the entity. Fields of type Markdown or Rich Text may be converted to HTML based on input parameters. If 'Fields' is specified, only those fields are included. The 'Format' parameter affects legacy rich text fields only.

Discussion