PerfexCRMInstall

Summary

Retrieve multiple leads from PerfexCRM, optionally applying filters and pagination controls.

Inputs

• Return All — Boolean to choose whether to return all leads or limit the number returned.
• Limit — Maximum number of leads to return when Return All is false (default 50).
• Offset — Number of leads to skip before starting to return results, for pagination (default 0).
• Filters — Optional filters to narrow down leads by status ID, source ID, assigned staff ID, or a search term.

Output shape

a list of lead records

If Return All is true, all leads matching the filters are returned; otherwise, pagination applies using Limit and Offset. The output is an array of lead objects.

Examples

Example 1: Return the first 50 leads with a specific status

Set Return All to false, Limit to 50, Offset to 0, and provide the Status filter with desired status ID.

Example 2: Retrieve all leads assigned to a specific staff member

Set Return All to true and provide the Assigned filter with the staff ID.