Yext Knowledge APIInstall

Summary

Retrieve a paginated list of listings for specified entities from the Yext Knowledge API, filtered by entity IDs, publisher IDs, statuses, and language.

Inputs

• Entity Ids — JSON array of entity IDs to filter listings. Defaults to all entities with a subscription if omitted.
• Publisher Ids — JSON array of publisher IDs to filter listings. Defaults to all subscribed publishers if omitted.
• Statuses — JSON array of listing statuses to filter by. Defaults to all listings excluding those with status DELETED or SYNC_STOPPED.
• Language (required) — Language code for the response (e.g., 'en', 'fr', 'ja'). Defaults to 'en'.
• Page Token — Token to retrieve the next page of results if paginated.
• Limit (required) — Number of results to return. Defaults to 100.
• Offset (required) — Number of results to skip for pagination. Cannot be used with Page Token. Defaults to 0.

Output shape

a list of listing records corresponding to the query parameters

Supports pagination via 'limit', 'offset', and 'pageToken' parameters. If the API response includes a nextPageToken, it can be supplied as 'pageToken' to fetch subsequent pages. The operation excludes listings with status DELETED or SYNC_STOPPED by default unless overridden by specifying statuses.

Examples

Example 1: Retrieve all listings for specific entity IDs in English.

Set 'Entity Ids' to a JSON array of desired entity IDs; keep 'Language' as 'en'; optionally adjust 'Limit' and 'Offset'.

Example 2: Fetch listings filtered by publisher IDs and status.

Provide 'Publisher Ids' and 'Statuses' as JSON arrays; 'Language' defaults to 'en'; adjust 'Limit' for number of results.