Yext Live APIInstall

Summary

List entities from the Yext Live API using various optional filters, sorting, paging, and formatting parameters to customize results.

Inputs

• Account Id (required) — The identifier for the Yext account to query.
• V (required) — API version date in YYYYMMDD format.
• Convert Markdown To HTML — Whether to return Markdown fields as HTML (true) or JSON (false).
• Convert Rich Text To HTML — Whether to return Rich Text fields as HTML (true) or JSON (false).
• Entity Types — Comma-separated list of entity types to filter by (e.g., location,event).
• Fields — Comma-separated list of fields to return, supporting dot notation for subfields (e.g., address.line1).
• Filter — URL-encoded JSON string with filtering conditions to apply to the entities returned.
• Format — Format for legacy rich text fields: markdown, html, or none.
• Languages — Comma-separated list of language codes to filter entity profiles by, with special handling for primary profiles.
• Limit — Number of results to return, defaulting to 10.
• Offset — Number of results to skip for paging, default 0; cannot be used with pageToken.
• Page Token — Token from previous response to retrieve the next page of results.
• Saved Filter Ids — Comma-separated list of saved filter IDs; returns only entities included in all specified filters.
• Sort By — JSON list of fields with sort direction (ASCENDING or DESCENDING) to order results.

Output shape

a list of entity records matching the query with requested fields and formatting

Supports pagination via 'limit', 'offset', and 'pageToken'. Filtering supports complex, URL-encoded JSON filters on entity fields with various matchers. Markdown and rich text fields can be optionally converted to HTML. Sorting and language preferences can be applied. Errors or empty responses are indicated via standard n8n execution output.

Examples

Example 1: List up to 10 location entities with names starting with 'Century' and open after 7 PM on 2018-08-28

Set Account Id, V (version), Entity Types to 'location', Filter to JSON filter with $startsWith and $ge matchers on fields.name and fields.time.start, Limit to 10.