1.5 KiB
1.5 KiB
Get Subscribers
array getSubscribers(array $filter = [], int $limit = 50, int $offset = 0)
This method returns a list of subscribers. To see the subscriber data structure, please check getSubscriber() documentation.
Arguments
| Argument | Type | Default | Description |
|---|---|---|---|
| $filter (optional) | array | empty | Filters to retrieve subscribers |
| $limit (optional) | int | 50 | The number of results that are returned |
| $offset (optional) | int | 0 | From where to start returning data |
Filter
Filter argument supports following array keys.
| Key | Type | Description |
|---|---|---|
| status | string | Specific status of subscribers. One of values: unconfirmed, subscribed, unsubscribed, bounced, inactive |
| listId | int | List id or dynamic segment id |
| minUpdatedAt | DateTime\int | DateTime object or timestamp of the minimal last update of subscribers |