Yext Live APIInstall

Summary

Retrieve the schema of a specific entity from the Yext Live API using the entity's external ID, type, language, and account information.

Inputs

• Account Id (required) — The ID of the Yext account to query.
• Entity Id (required) — The external ID of the requested Entity.
• Language Code (required) — The language code corresponding to the language of the profiles to retrieve.
• Entity Type (required) — The type of the entity, e.g., atm, event, healthcareFacility, or a custom entity API name.
• V (required) — A date parameter in YYYYMMDD format for versioning the API request.

Output shape

a single JSON object representing the entity schema as returned by the Yext Live API

The operation returns the full schema details of the specified entity. Requests include optional node settings such as batching, proxy, timeout, and SSL ignore options that do not affect the output shape.

Examples

Example 1: Retrieve entity schema for a restaurant entity in English with version date 20230101.

Provide Account Id, Entity Id, Language Code as 'en', Entity Type as 'restaurant', and V as '20230101'. The node returns the entity's schema in JSON format.