Actaport icon

Actaport

Interact with the Actaport API

Actions69

Contact → Get Many

AI-generated

Summary

Retrieve a list of contacts from Actaport with support for pagination, filtering, and sorting.

Inputs

  • Page — Page index starting from 0 to specify which page of results to retrieve (default is 0). Effective only when 'Return All' is false.
  • Size — Number of contacts to return per page (default is 100). Effective only when 'Return All' is false.
  • Filters — One or more filters to apply to the contact list. Each filter requires a field name, an operator, and a value. The filters are sent as query parameters to filter the results accordingly.
  • Sort — One or more sorting criteria to order the retrieved contacts. Each criterion includes the field to sort by and the direction (asc or desc). These are sent as query parameters to sort the results.
  • Return All — Boolean flag indicating whether to retrieve all contacts matching the criteria (true) or to limit the results by page and size parameters (false).
  • Request Options — Additional HTTP request options such as batching settings, SSL certificate validation, proxy configuration, and timeout duration.

Output shape

a list of contact records

If 'Return All' is true, all contacts matching filters and sorting are returned by paginating internally. If 'Return All' is false, only the specified page with defined size is returned. Filters and sorting are optional. Error responses are propagated as workflow errors.

Examples

Example 1: Get the first page of 100 contacts with no filters or sorting.

Page=0, Size=100, Return All=false

Example 2: Get all contacts with a filter on the 'lastName' field equaling 'Smith' and sorted ascending by 'firstName'.

Return All=true, Filters=[{field:'lastName', operator:'eq', value:'Smith'}], Sort=[{field:'firstName', direction:'asc'}]

Links

Discussion