Unleashed icon

Unleashed

Interact with Unleashed inventory management API

Actions26

Customer → Get Many

AI-generated

Summary

Retrieves multiple Unleashed customers based on optional filters, with support for sorting, limiting results, and including all associated contacts.

Inputs

  • returnAll — Whether to return all results or only up to a given limit.
  • limit — Max number of results to return. Only applies when returnAll is false. Minimum value is 1.
  • filters — A collection of filter objects to narrow the search. Available filters include contact email, currency, customer code/name/type, sales order group, sell price tier, Xero contact ID, and status flags like stop credit, include obsolete, and include all contacts.
  • modifiedSince — Filter customers modified since this date/time.
  • orderBy — Field to order results by (e.g., CustomerCode, CustomerName, LastModifiedOn).
  • sort — Sort direction for results: Ascending (default) or Descending.

Output shape

A list of customer items. Each item contains customer details and, if enabled, all associated contacts.

Returns data in Unleashed's standard customer object structure. When returnAll is true, the node fetches pages of results until all matching customers are retrieved.

Examples

Example 1: Retrieve the first 50 active customers ordered by name

Return All: false, Limit: 50, Filters: Include All Contacts: true, Order By: CustomerName

Example 2: Find customers modified after a specific date

Return All: true, Filters: Modified Since: [date], Sort: Descending

Example 3: Get all customers for a specific sales order group

Return All: true, Filters: Sales Order Group: [group name]

Links

Discussion