» Lists » Subscribers » Get

GET lists/{list_id}/subscribers

Retrives the list's subscribers

Resource

Method GET
URL http://api.responder.co.il/v1.0/lists/{list_id}/subscribers

Parameters

limit
optional

Maximum number of Lists to be retrived.
Range between 1 to 500.

Example value: 25
Default value: 500
offset
optional

The position to start the count of "limit" from.
Value must be larger or equal to 0

Example value: 10
Default value: 0
dir
optional

The order of the subscribers. For "dir=0" the subscribers will be in ascending order according to subscription date. For "dir=1" the subscribers will be in descending order according to subscription date.
Value can be either 0 or 1

Example value: 1
Default value: 0
subscriber_id
optional

The identity of specific subscriber.
Value can be either id or email

Example value: 123456 Another example value: israeli@gmail.com
Default value: null
min_join_date
optional

The minimum for subscription date of subscriber.
Value has to be a valid date in YYYY-MM-DD HH:mm format

Example value: 2015-01-01 00:00
Default value: null
max_join_date
optional

The maximum for subscription date of subscriber.
Value has to be a valid date in YYYY-MM-DD HH:mm format

Example value: 2018-06-30 00:00
Default value: null

Example - PHP (see more in 'index.php' file in the SDK)

$responder->http_request("lists/{$list_id}/subscribers?min_join_date=2018-01-01 00:00&max_join_date=2018-06-01 00:00", 'get');

Example - ASP.net (see more in 'TestResponderWrapper.cs' file in the SDK)

m_Responder.http_request("lists/" + listId.ToString() + "?offset=0&min_join_date=2015-02-03 00:00", "GET");

Example

[
   {
      [ID] => 123456789,
      [NAME] => "Responder",
      [EMAIL] => "responder@responder.co.il",
      [PHONE] => "",
      [PERSONAL_FIELDS] => {
         30657 : "Tel Aviv"
      }
   }
]