Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Listings → List Publisher Suggestions

AI-generated

Summary

Retrieve a paginated list of publisher suggestions for Listings with optional filters for location IDs, publisher IDs, and suggestion statuses.

Inputs

  • Limit — Number of publisher suggestions to return, defaults to 10.
  • Offset — Number of suggestions to skip for pagination; cannot be used with pageToken.
  • Location Ids — JSON array of location IDs to filter suggestions; defaults to all account locations with Listings subscription.
  • Publisher Ids — JSON array of publisher IDs to filter suggestions; defaults to all publishers subscribed by the account.
  • Statuses — JSON array of suggestion statuses to filter results, e.g., WAITING_ON_CUSTOMER or EXPIRED.

Output shape

a list of publisher suggestion objects matching the specified filters and pagination

Supports pagination via 'limit' and 'offset' parameters; filters by location IDs, publisher IDs, and statuses are optional. The response is a JSON array of publisher suggestions.

Discussion