Yext Knowledge APIInstall

Summary

List entities from a Yext account's Knowledge Manager according to specified filters, field selections, sorting, pagination, and formatting options.

Inputs

• Account Id (required) — The ID of the Yext account to list entities for.
• V (required) — API version date in YYYYMMDD format.
• Convert Markdown To HTML — Optional flag to convert Markdown fields to HTML (true or false).
• Convert Rich Text To HTML — Optional flag to convert Rich Text fields to HTML (true or false).
• Entity Types — Comma-separated list of entity types to filter by, e.g., 'location,event' or custom entity types.
• Fields — Comma-separated list of field names to return. Supports dot notation for subfields and custom fields (c_*).
• Filter — URL-encoded JSON string representing one or more filtering conditions applied to entities, supporting complex nested filters and a variety of matchers per field type.
• Format — Format for Legacy Rich Text fields if present: 'markdown', 'html', or 'none'. Default is 'markdown'.
• Languages — Comma-separated list of language codes to return entities with profiles in specified languages or 'primary' for the primary profile.
• Limit — Number of entities to return. Defaults to 10.
• Offset — Number of entities to skip for pagination. Cannot be used with pageToken. Defaults to 0.
• Page Token — Token for retrieving next page of results from a previous response.
• Resolve Placeholders — Whether to resolve embedded placeholder fields in location objects (true or false). Defaults to false.
• Sort By — List of field and direction pairs to sort results by, in JSON array format.

Output shape

a list of entity objects matching the query parameters

Supports pagination via limit, offset, and pageToken. Returned entity fields can be filtered for specific fields. Filters support complex JSON-based queries with many matchers dependent on field types. Markdown and Rich Text can be optionally returned as HTML.