PerfexCRMInstall

Summary

Retrieve multiple contacts from PerfexCRM with optional filtering, pagination, and limit controls.

Inputs

• Return All (required) — Whether to return all available contacts or limit the number returned.
• Limit — Maximum number of contacts to return; effective only if Return All is false.
• Offset — Number of contacts to skip before starting to collect the results; effective only if Return All is false.
• Filters — Optional filters to narrow down returned contacts by Active status, Customer ID, or Primary contact status.

Output shape

an array of contact objects

If Return All is enabled, returns all matching contacts without pagination. Otherwise, returns a limited array respecting the specified Limit and Offset. If the API returns multiple pages and Return All is true, all pages are fetched iteratively.

Examples

Example 1: Fetch all primary active contacts associated with a specific customer ID

Set Return All to true and Filters to Active = Yes, Is Primary = Yes, Customer ID = '12345'.

Example 2: Fetch first 10 inactive contacts skipping the first 5

Set Return All to false, Limit to 10, Offset to 5, and Filters to Active = No.