Yext Knowledge APIInstall

Summary

Searches for locations within the Yext Knowledge Manager using optional filters, supporting pagination through limit and offset parameters.

Inputs

• Limit — Specifies the maximum number of location results to return. Defaults to 10.
• Offset — Specifies the number of results to skip for pagination purposes. Defaults to 0.
• Filters — A URL-encoded JSON array string of filter objects that restrict the returned locations based on various fields. Filters are combined using AND logic. Supports many filter types including text matching, numeric ranges, categories, dates, booleans, and custom fields.

Output shape

a list of location records matching the search criteria

Results are paginated by the 'limit' and 'offset' parameters. Filters must be provided as a URL-encoded JSON string. All filters apply as an intersection (AND) to restrict results.

Examples

Example 1: Find up to 10 locations with names starting with "Guitar"

Set Limit to 10; set Filters to '%5B%7B%22name%22%3A%7B%22startsWith%22%3A%5B%22Guitar%22%5D%7D%7D%5D' (URL encoding of [{"name":{"startsWith":["Guitar"]}}])

Example 2: Page through locations, skipping first 20 and returning 10 more

Set Limit to 10; set Offset to 20; no filters set