Skip to content

SDK method

tools.listSegments

List segments. Convenience alias for list_segments, forwarding to tinbox.api.segments.list.query.

Signature

ts
listSegments(input: Parameters<TinboxTools["listSegments"]>[0]): ReturnType<TinboxTools["listSegments"]>

Parameters

NameTypeRequiredDescription
audienceIdstringyesThe audience whose segments to list (from list_audiences).

Returns

ReturnType<TinboxTools["listSegments"]>

Example

ts
await tinbox.tools.listSegments({
  "audienceId": "aud_…"
});