TukiMate icon

TukiMate

Interact with TukiMate API (conversations, contacts, teams, projects, clients, sources)

Actions48

Client → List

AI-generated

Summary

Retrieve a list of clients from TukiMate, optionally filtering by client type, status, and tier; searching by client name; and ordering results by specified fields and order modes. Supports simplified output to return only essential client fields.

Inputs

  • Type Filter Mode — Choose whether to specify client type filter from a predefined list or manually via a string.
  • Type Filter — Select the client type to filter by (corporate, individual, partner, or all). Shown if Type Filter Mode is 'From List'.
  • Type Filter (Manual) — Manually specify the client type filter as a string (corporate, individual, partner, or empty for all). Shown if Type Filter Mode is 'Manual'.
  • Status Filter Mode — Choose whether to specify client status filter from a predefined list or manually via a string.
  • Status Filter — Select the client status to filter by (active, inactive, prospect, or all). Shown if Status Filter Mode is 'From List'.
  • Status Filter (Manual) — Manually specify the client status filter as a string (active, inactive, prospect, or empty for all). Shown if Status Filter Mode is 'Manual'.
  • Tier Filter Mode — Choose whether to specify client tier filter from a predefined list or manually via a string.
  • Tier Filter — Select the client tier to filter by (standard, premium, enterprise, or all). Shown if Tier Filter Mode is 'From List'.
  • Tier Filter (Manual) — Manually specify the client tier filter as a string (standard, premium, enterprise, or empty for all). Shown if Tier Filter Mode is 'Manual'.
  • Search — Search for clients by matching text in their name.
  • Order By Mode — Choose whether to specify the order-by field from a predefined list or manually via a string.
  • Order By — Select the field to order by (name or created_at). Shown if Order By Mode is 'From List'.
  • Order By (Manual) — Manually specify the order-by field as a string (name or created_at). Shown if Order By Mode is 'Manual'.
  • Order Mode — Choose whether to specify the sort order (ascending or descending) from a list or manually via a string.
  • Order — Select sorting order (ascending or descending). Shown if Order Mode is 'From List'.
  • Order (Manual) — Manually specify the sort order as a string (asc or desc). Shown if Order Mode is 'Manual'.
  • Simplified Output — Enable to return only essential client fields and exclude internal metadata fields.

Output shape

a list of client records

The returned client list respects the applied filters and order settings. If Simplified Output is enabled, the result includes only essential client fields, excluding internal properties like 'tenant_id' and timestamps. Pagination is handled internally by the node if needed, transparently returning all matching clients.

Links

Discussion