Yext Live APIInstall

Summary

Retrieve a specific entity from the Yext Live API by its external ID, optionally filtering returned fields and controlling content format.

Inputs

• Account Id (required) — The identifier of the Yext account to query.
• Entity Id (required) — The external ID of the entity to retrieve.
• V (required) — The API version date in YYYYMMDD format to specify the version of the Live API to use.
• Convert Markdown To HTML — If set to true, returns markdown fields as HTML; if false, returns as JSON.
• Convert Rich Text To HTML — If set to true, returns rich text fields as HTML; if false, returns as JSON.
• Fields — Comma-separated list of field names to return; supports dot notation for substructures and custom fields with 'c_*' naming.
• Format — Controls format of legacy rich text fields; valid values are 'markdown', 'html', or 'none'.
• Request Options — Optional settings including batching size and interval, SSL certificate validation override, proxy configuration, and HTTP timeout.

Output shape

a single record representing the requested entity with fields filtered and formatted according to input parameters

Response fields correspond to the specified 'Fields' input; markdown and rich text fields are returned as JSON or HTML depending on parameters; pagination does not apply since this gets a single entity by ID.

Examples

Example 1: Get an entity with ID 'entity-123' from account 'account-456' for API version '20230101', requesting only specific fields 'name,address.line1' and converting markdown to HTML

Account Id='account-456', Entity Id='entity-123', V='20230101', Convert Markdown To HTML='true', Fields='name,address.line1'