Shop APIInstall

Summary

Execute a search query to retrieve prospects from the Shop API based on an optional JSON filter, supporting pagination with options to limit the number of records or retrieve all pages up to a specified maximum.

Inputs

• Request filter — Optional JSON string representing the filter criteria for prospects to search.
• Get All Pages — Boolean flag to retrieve all available pages of prospect search results.
• Limit — Number to limit the maximum records returned when not retrieving all pages.
• Max Pages — Maximum number of pages to retrieve when 'Get All Pages' is enabled; restricts pagination.

Output shape

a list of prospect objects matching the search filter, each yielded as a separate item

If 'Get All Pages' is false, results include up to 'Limit' records from a single page. If 'Get All Pages' is true, multiple pages are fetched up to 'Max Pages' if specified. The response items contain JSON representing individual prospect records as returned by the API.

Examples

Example 1: Search for prospects with no filter, limited to 20 records

filter="" (empty), getAllPages=false, limit=20

Example 2: Search for all prospects matching a specific criterion with pagination

filter="{...}", getAllPages=true, maxPages=5

Links

• n8n community nodes installation guide