TukiGrowth icon

TukiGrowth

Interact with the TukiGrowth API

Actions185

Customer → List

AI-generated

Summary

List customer records within a specified organization and client context, applying optional filters such as pagination, status, and search terms.

Inputs

  • organizationId (required) — Select the organization to operate in, either from a list or by specifying its ID.
  • clientIdSelect — Optionally specify the client to operate on, either from a list or by ID.
  • filters — Optional filters for listing customers including page (number), limit (results per page), status (filter by customer status), and search (search term).
  • options — Additional options including Simplify Output to receive minimal output format and Debug Mode to include debug information in the output.

Output shape

a list of customer records with detail according to simplifyOutput option

The output defaults to simplified customer data unless Simplify Output is disabled. Debug information can be included if Debug Mode is enabled. Pagination and filtering are supported via input parameters.

Examples

Example 1: Retrieve the first 20 active customers within a specific organization and client, with simplified output.

Set Organization and Client, Filters with page=1, limit=20, status='active', and options.simplifyOutput=true.

Links

Discussion