Pax8Install

Summary

Lists companies from the Pax8 API with optional filtering, sorting, and pagination controls.

Inputs

• baseUrl — Base URL for the Pax8 API. Defaults to https://api.pax8.com.
• returnAll — When true, paginates automatically to return all results. Controls whether page/size or returnAll/maxResults logic applies.
• maxResults — Maximum number of results to return. Zero (0) means no limit. Applied when returnAll is false.
• page — Page number to request. Defaults to 0 (first page). Ignored when returnAll is true.
• size — Number of company records to return per page. Defaults to 0 (unlimited per page). Ignored when returnAll is true.
• sort — Sort companies by field and direction formatted as fieldName,direction (e.g., name,desc). Available fields: name, city, country, stateOrProvince, postalCode.
• city — Filter companies by exact city match.
• country — Filter companies by exact country match.
• stateOrProvince — Filter companies by exact stateOrProvince match.
• postalCode — Filter companies by exact postalCode match.
• selfServiceAllowed — Filter companies by selfServiceAllowed boolean value.
• billOnBehalfOfEnabled — Filter companies by billOnBehalfOfEnabled boolean value.
• orderApprovalRequired — Filter companies by orderApprovalRequired boolean value.
• status — Filter companies by status. Options: Active, Inactive, Deferred (default: Active).

Output shape

array

Returns the array of company objects from the API's content field. If the response contains no content, falls back to returning the raw response object. Pagination outputs (next page marker, total count, etc.) are not explicitly exposed but may be available via downstream nodes.

Links

• n8n community nodes installation guide