API

API documentation

Access all the documentation of our API.

getSubscribers

Description: Displays the list of subscribers from a list. (The request limit for this function is 10 requests each minute)
```
getSubscribers(string auth_token,integer list_id,integer status,integer block_index,integer all_fields,integer complete_json)
```
- Parameters
- auth_token (string)
  
  Your client authentication token
- list_id (integer)
  
  List identifier
- status (integer)
  
  (Optional) Segment the subscribers by status. 0: active subscribers. 1: non-verified subscribers. 2: subscribers who have unsubscribed. 3: hard bounced subscribers. 4: subscribers who have complained.
- block_index (integer)
  
  The result returns up to a maximum of 10,000 blocks, where 0 from subscriber 1 to 10,000, 1 from subscriber 10,001 to 20,000. Default=0
- all_fields (integer)
  
  Returns all the fields of each subscriber. By default=0
- complete_json (integer)
  
  Returns a complete JSON. By default=0
- Return value
- dict
  
  Returns a dictionary of subscribers indexed by their email addresses.