Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Customer → Get

AI-generated

Summary

Retrieve detailed information about a specific customer from the Xentral system by providing the customer's unique ID.

Inputs

  • Customer ID (required) — The unique ID of the customer to retrieve.
  • Max Pages — Maximum number of API pages to fetch; this applies only when returning all records but is visible here when the 'returnAll' option is enabled.

Output shape

a single record containing detailed customer information, including nested objects for contact details, financials, shipping, and other related customer properties.

Requires a valid Customer ID. The operation returns the full customer data object as provided by the Xentral API. Pagination parameters like Max Pages are relevant only with 'returnAll' scenarios which are not typical for a single 'Get' operation by ID. Errors may be returned if the customer ID is invalid or the customer does not exist.

Links

Discussion