Yext Live APIInstall

Summary

Retrieve a list of language profiles for a specified Entity within a Yext account.

Inputs

• Account Id (required) — The Yext account identifier to query.
• Entity Id (required) — The external ID of the requested Entity whose language profiles to list.
• V (required) — A date string in YYYYMMDD format used for versioning the API request.
• Convert Markdown To HTML — Optional parameter to determine if Markdown fields should be returned as HTML (true) or as JSON (false).
• Convert Rich Text To HTML — Optional parameter to determine if Rich Text fields should be returned as HTML (true) or as JSON (false).
• Entity Types — Comma-separated list of Entity types to filter the returned language profiles by.
• Fields — Comma-separated list of field names to return; supports dot notation for nested fields.
• Format — Format for fields of type "Legacy Rich Text", valid values are markdown, html, or none.
• Language Codes — Comma-separated list of language codes to filter profiles to specific languages.
• Request Options — Options for batching requests, handling SSL validation, proxy settings, and request timeout.

Output shape

a JSON object containing the list of language profiles matching the specified parameters for the given Entity.

Supports optional query parameters to customize returned fields and data formatting. Uses batching for large requests if configured. Requires valid OAuth2 credentials for authentication.

Examples

Example 1: List language profiles for an entity filtering on specific languages and converting Markdown to HTML.

Set Account Id, Entity Id, V date parameter, specify Language Codes, and set Convert Markdown To HTML to true.