Pax8

Interact with the Pax8 Partner API

Actions100

Quotes → Get quotes list

AI-generated

Summary

Retrieve quotes from the Pax8 API with 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 visibility of maxResults, limit, and page parameters.
  • maxResults — Maximum number of results to return. 0 means no limit. Only effective when returnAll is true.
  • limit — Query parameter for result limit. Shown when returnAll is false.
  • page — Query parameter for page number. Shown when returnAll is false.
  • sort — Sort quotes by field and direction. Options include id, status, client.name, createdBy, createdOn, updatedOn, totals.initialTotal, totals.recurringTotal. Format: field,direction (e.g., status,desc).
  • search — Search across fields such as client name, reference code, created by user name, and invoice totals.
  • status — Filter quotes by status. Accepts a comma-separated list. Options: draft, assigned, sent, closed, declined, accepted, changes_requested, expired, pending.
  • account — Query parameter specifying account type. Options: user, partner. Defaults to user.
  • partnerId — Query parameter for partner identifier.
  • intentType — Query parameter for intent type. Options: PARTNER_TO_CLIENT, PAX8_TO_PARTNER, PAX8_TO_PARTNER_CLIENT. Defaults to PARTNER_TO_CLIENT.

Output shape

array

Returns an array of quote objects from the Pax8 API. When returnAll is true, all paged results are merged into a single array. If the API returns no content, the raw response is returned instead.

Links

Discussion