TukiGrowth icon

TukiGrowth

Interact with the TukiGrowth API

Actions185

Audience → List

AI-generated

Summary

List audiences filtered by organization and client with optional pagination, status filtering, and search term to refine results.

Inputs

  • organizationId (required) — Select the organization to operate in, either from a list or by ID.
  • clientIdSelect — Optionally select the client within the organization to filter audiences, either from a list or by ID.
  • filters.page — Page number for pagination; defaults to 1 if not specified.
  • filters.limit — Number of results per page; defaults to 20 if not specified.
  • filters.status — Filter audiences by their status.
  • filters.search — Search term to filter audiences by matching content.
  • options.simplifyOutput — Return simplified, minimal output if true; defaults to true.
  • options.debugMode — Include debug information in the output if true.

Output shape

a paginated list of audience records matching the specified organization, client, and filters

The output is optionally simplified depending on the simplifyOutput option. Debug information can be included if debugMode is enabled. Pagination is supported via page and limit filters.

Examples

Example 1: Retrieve first page of audiences for a specific organization with a limit of 10, returning simplified data.

Set organizationId to the target organization, filters.page to 1, filters.limit to 10, and options.simplifyOutput to true.

Example 2: List audiences for a client filtered by status 'Active' and search term 'retail'.

Set organizationId, clientIdSelect to target client, filters.status to 'Active', filters.search to 'retail', with default pagination and simplification.

Links

Discussion