Shop API icon

Shop API

Call Shop API

Activities → Search

AI-generated

Summary

Search for activities using an optional JSON filter to retrieve matching activity records with control over pagination.

Inputs

  • Request filter — Provide a JSON string as filter criteria to narrow down the activity search results.
  • Get All Pages — Enable to fetch all pages of results rather than a single page.
  • Limit — Set the maximum number of activity records to retrieve per request, applicable when not fetching all pages.
  • Max Pages — Specify a maximum number of pages to retrieve when fetching all pages.

Output shape

a list of activity records matching the filter criteria

If 'Get All Pages' is false, the output list is limited to the specified 'Limit'. If 'Get All Pages' is true, multiple pages of results are retrieved up to 'Max Pages' if set, otherwise all available pages. Each output item contains one activity record in JSON format.

Links

Discussion