Yext Knowledge APIInstall

Summary

List all language profiles associated with a specified Yext account, optionally filtering, sorting, paginating, and customizing the returned data format and content.

Inputs

• Account Id (required) — The unique identifier for the Yext account whose language profiles are to be listed.
• V (required) — The API version date in YYYYMMDD format for the request.
• Convert Markdown To HTML — Determines whether Markdown fields in the response are returned as HTML (true) or as JSON (false).
• Convert Rich Text To HTML — Determines whether Rich Text fields in the response are returned as HTML (true) or as JSON (false).
• Entity Types — Comma-separated list of entity types to filter language profiles by.
• Fields — Comma-separated list of specific field names to include in the response, supporting dot notation for nested fields.
• Filter — URL-encoded JSON string representing complex filter criteria to restrict the returned language profiles.
• Format — Specifies how legacy rich text fields are formatted; valid values are markdown, html, or none.
• Language Codes — Comma-separated language codes specifying which language profiles to retrieve.
• Limit — Number of language profiles to return (default is 10).
• Offset — Number of language profiles to skip for pagination (default is 0); cannot be used with pageToken.
• Page Token — Token to retrieve the next page of results from a previous response.
• Rendered — Controls the detail level of the response: false returns only overridable or language-specific fields, true returns the full profile including common data.
• Sort By — JSON array specifying fields and sort directions (ASCENDING or DESCENDING) to order the results.
• Request Options — Advanced settings including batching parameters, SSL options, proxy configuration, and request timeout.

Output shape

a list of language profile records matching the specified criteria, potentially paginated

The response includes language profiles filtered, sorted, and limited per input parameters. Pagination is supported via limit, offset, and pageToken. Fields and output formats can be customized. Filters support complex JSON criteria with combinators and various matchers. Batch and request options affect execution behavior but not response shape.