TukiGrowth icon

TukiGrowth

Interact with the TukiGrowth API

Actions185

Client → List

AI-generated

Summary

List clients within a specified organization, supporting optional filters for pagination, status, and search terms to refine the results.

Inputs

  • organizationId (required) — Specify the organization context either by selecting from a list or by entering the organization's ID to scope the client listing.
  • filters — Optional set of filters including page number (pagination), limit (results per page), status to filter clients by their status, and a search string to query client records.
  • options — Optional settings such as simplifying the output to a minimal form and enabling debug mode to include debug information in the response.

Output shape

a list of client records belonging to the specified organization, optionally simplified or including debug data based on input options

Results can be paginated and filtered; when "Simplify Output" is enabled (default true), the client data returned is minimal. Enabling "Debug Mode" adds additional debug information to the output.

Examples

Example 1: Get the first page of active clients with a limit of 20, returning simplified data.

Set organizationId by selecting the organization from the list, specify filters with page=1, limit=20, status='active', and options simplifyOutput=true, debugMode=false.

Links

Discussion