Yext Knowledge APIInstall

Summary

Retrieve a list of business listings filtered and paginated according to parameters such as limit, offset, page token, location IDs, publisher IDs, statuses, and language.

Inputs

• Limit — Number of results to return (default 100).
• Offset — Number of results to skip for pagination (cannot be used with pageToken; default 0).
• Page Token — Token from a previous response to retrieve the next page of listings.
• Location Ids — JSON array of location IDs to limit the listings to specific account locations with a Listings subscription (defaults to all).
• Publisher Ids — JSON array of publisher IDs to filter listings by, such as MAPQUEST or FACEBOOK (defaults to all subscribed publishers).
• Statuses — JSON array of listing statuses to filter by, e.g., WAITING_ON_YEXT or WAITING_ON_CUSTOMER.
• Language — Language code (e.g., en, fr, de) to specify the language of data returned (default 'en').

Output shape

a JSON object containing a page of Listings matching the query parameters, including possible pagination tokens for retrieving further pages.

If pagination tokens are used, provide the pageToken parameter for subsequent requests. Only one of offset or pageToken should be used per request. Returned data includes listing details filtered per the input parameters.

Examples

Example 1: List first 50 listings for specified locations

Set Limit to 50, Location Ids to ['loc123','loc456'], leave other params default.