Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Customer → Get Many

AI-generated

Summary

Retrieve multiple customer records from the Xentral API, supporting pagination and result limits.

Inputs

  • Return All — Whether to return all customer records or limit the results.
  • Limit — Maximum number of customer records to return when not returning all (default 50, max 100).
  • Max Pages — Maximum number of API pages to fetch when returning all results (default 1000, each page contains 50-150 records).

Output shape

a list of customer objects

When 'Return All' is true, up to 'Max Pages' of API pages will be fetched, each containing 50-150 customer records; otherwise, up to 'Limit' customers are returned. Results are paginated internally.

Examples

Example 1: Fetch up to 100 customers

Set 'Return All' to false and 'Limit' to 100 to get up to 100 customers.

Example 2: Fetch all customers up to 20,000 records

Set 'Return All' to true and 'Max Pages' to 200 to retrieve up to approximately 20,000 customers (assuming 100 records per page).

Links

Discussion