Yext Live APIInstall

Summary

Retrieve a paginated list of language profile entities from Yext's Live API, filtered and formatted according to specified criteria.

Inputs

• Account Id (required) — The identifier of the Yext account from which to list language profiles.
• V (required) — API version date in YYYYMMDD format.
• Convert Markdown To HTML — Optional flag to convert Markdown fields to HTML: 'true' returns HTML, 'false' returns JSON.
• Convert Rich Text To HTML — Optional flag to convert Rich Text fields to HTML: 'true' returns HTML, 'false' returns JSON.
• Entity Types — Comma-separated list of entity types to filter the results, e.g., 'location,event'. Supports predefined and custom entity types.
• Fields — Comma-separated list of specific field names to return, supporting dot notation for substructures and custom fields with 'c_*' names.
• Filter — URL-encoded JSON string defining filtering conditions on entity fields using supported matchers, combinators, and negations.
• Format — Output format for legacy rich text fields; can be 'markdown', 'html', or 'none'. Defaults to 'markdown'.
• Language Codes — Comma-separated list of language codes specifying profile languages to retrieve.
• Limit — Number of results to return per request, defaulting to 10.
• Offset — Number of results to skip for pagination, defaulting to 0. Cannot be used with 'pageToken'.
• Page Token — Token from a previous response to fetch the next page of results.
• Sort By — JSON array string defining fields and directions (ASCENDING or DESCENDING) to sort results.
• Request Options — Advanced request settings including batching, proxy, SSL handling, and timeout.

Output shape

a paginated list of language profile entity records matching the specified criteria

Results can be paged via 'limit', 'offset', and 'pageToken' parameters. Fields returned respect filtering and field selection parameters. Markdown and rich text fields can be optionally converted to HTML. The 'filter' parameter uses a powerful JSON-based syntax supporting multiple matchers and combinators for fine-grained entity selection.