Pax8

Interact with the Pax8 Partner API

Actions100

Contacts → List Contacts

AI-generated

Summary

List paged contacts from a Pax8 company.

Inputs

  • baseUrl — Base URL for the Pax8 API.
  • returnAll — Whether to return all results by paginating automatically.
  • maxResults — Maximum number of results to return. 0 means no limit.
  • page — The page number to request for in the contacts list.
  • size — Return this number of records per page.
  • companyId (required) — Path parameter for the company ID.

Output shape

Returns contact items extracted from the API response's 'content' field as separate output items. Falls back to returning the raw response if no content is returned. When returnAll is true, pagination continues using a larger page size until all results are fetched.

Pagination behavior is controlled by page/size when returnAll is false, and by automatic larger-page pagination when returnAll is true.

Links

Discussion