Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Listings → List Statuses

AI-generated

Summary

Retrieve a list of listing statuses for specified entities within a Yext account on a given version date.

Inputs

  • Account Id (required) — The unique identifier of the Yext account to query.
  • V (required) — The version date in YYYYMMDD format, specifying the snapshot of data to retrieve.
  • Publisher Id (required) — The identifier of the publisher to filter listing statuses for.
  • Entity Ids — Optional comma-separated list of entity IDs to filter. If omitted, lists statuses for all entities with a listings subscription.
  • Page Token — Token for pagination to retrieve the next page of results if available from a previous response.
  • Limit — The maximum number of results to return. Defaults to 100.
  • Offset — Number of results to skip for pagination. Cannot be used together with Page Token.

Output shape

a collection of listing status records for the specified entities, possibly paginated

Supports pagination using either offset or pageToken query parameters, but these cannot be used simultaneously. The output includes listing status details filtered by the specified account, publisher, version date, and optional entity IDs.

Discussion