Skip to content

SDK method

tools.getAudience

Get audience details. Convenience alias for get_audience, forwarding to tinbox.api.audiences.get.query.

Signature

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

Parameters

NameTypeRequiredDescription
idstringyesThe audience id.

Returns

ReturnType<TinboxTools["getAudience"]>

Example

ts
await tinbox.tools.getAudience({
  "id": "<id>"
});