Yext Knowledge APIInstall

Summary

Retrieve a list of duplicate listings from the Yext Knowledge API filtered by optional criteria.

Inputs

• Limit — Number of duplicate results to return, defaults to 10.
• Offset — Number of results to skip for pagination, cannot be used together with a page token; defaults to 0.
• Location Ids — JSON array of location IDs to filter duplicates; defaults to all account locations with a Listings subscription.
• Publisher Ids — JSON array of publisher IDs to filter duplicates; if unspecified, defaults to all publishers subscribed by the account.
• Statuses — JSON array of duplicate statuses to filter returned duplicates (e.g., POSSIBLE_DUPLICATE, SUPPRESSION_REQUESTED).
• Request Options — Collection of request options including batching, SSL handling, proxy, and timeout settings to customize the API request behavior.

Output shape

a list of duplicate listing records returned from the Yext Knowledge API as JSON objects

Results support pagination with limit and offset parameters; no additional envelope is specified so handle response accordingly.

Examples

Example 1: Retrieve up to 20 duplicate listings for specific locations and publishers, filtering by status.

Set Limit to 20, specify Location Ids and Publisher Ids as JSON arrays, and provide desired Statuses.