Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Listings → List Methods

AI-generated

Summary

Retrieve a list of listings for specified entities within a Yext account and publisher, optionally paginated and filtered by locale and entity IDs.

Inputs

  • Account Id (required) — The unique identifier of the Yext account to retrieve listings from.
  • V (required) — API version date in YYYYMMDD format.
  • Publisher Id (required) — The identifier of the listings publisher to filter results by.
  • Locale (required) — Locale code to filter listings.
  • Entity Ids — Optional comma-separated list of entity IDs to filter the listings. Defaults to all entities with a listings subscription if omitted.
  • Page Token — Token to retrieve the next page of results when paginating through large result sets.
  • Limit — Number of results to return per request. Defaults to 100.
  • Offset — Number of results to skip for pagination, cannot be used together with Page Token.

Output shape

a JSON object containing a paginated list of listing records matching the query parameters.

Response may include a nextPageToken field for pagination. Use Page Token or Offset to navigate pages but not both simultaneously.

Discussion