SDK method
tools.listSubscribers
List subscribers. Convenience alias for list_subscribers, forwarding to tinbox.api.members.list.query.
Signature
ts
listSubscribers(input: Parameters<TinboxTools["listSubscribers"]>[0]): ReturnType<TinboxTools["listSubscribers"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
audienceId | string | yes | The audience id. |
status | "subscribed" | "unsubscribed" | "pending" | "cleaned" | "transactional" | no | Filter by subscription status. |
tag | string | no | Filter by tag name. |
search | string | no | Search by email or name. |
limit | number | no | Max results (default 50, max 200). |
Returns
ReturnType<TinboxTools["listSubscribers"]>
Example
ts
await tinbox.tools.listSubscribers({
"audienceId": "aud_…"
});