List of subscribers (Subscribers.Get)

Description

Returns the list of subscribers which exist in the target subscriber list.

Input Parameters

Command=Subscribers.Get [required]

This parameter defines the API command to run. It should be equal to Subscribers.Get.

ResponseFormat [optional] [default=XML]

Defines the response data format. It can be equal to XML or JSON .

SessionID [required]

Your session ID. In order to run this API call, you need to be logged in and have session ID.

ListID [required]

ID number of the target subscriber list. List ID numbers can be obtained from list settings page.

RPP [required]

Number of list records to return back for each API call

SegmentID [optional]

ID number of a segment if you want to receive the list of subscribers of a specific list segment

StartFrom [optional]

Index number to start retrieving subscribers from (Ex: StartFrom=0, RPP=20 means retrieving 20 subscribers from the beginning)

SearchKeyword [optional]

Keyword to match in subscriber list

SearchField [optional]

Field to perform search in

Output Parameters

Success [true or false]

If an error has occurred, this parameter will be equal to false. Otherwise it will be set to true.

ErrorCode [integer]

If an error has occurred, this parameter will contain error codes. Otherwise it will be set to 0.

SessionID [string]

If login was successful, this parameter will contain the session ID that you will need on your following API calls.

Subscribers [array]

Array containing the list of subscribers

Error Codes

#1

List ID is missing

#2

List not found

#3

Maximum allowed RPP limit is exceeded. Max 1,000 records at a time.

#9998

Unauthorized access. User login required to execute this API call.

#9999

Invalid API call. Please check the API command and try again.

Example

Request:

curl http://acme.sendloop.com/api/v2/Command=Subscribers.Get&
&SessionID=759ekrt4efgolvtnqifboi7b00
&ResponseFormat=XML
&ListID=19

Response:

<?xml version="1.0" encoding="utf-8"?>
<response>
    <Success><![CDATA[1]]></Success>
    <ErrorCode>
        <subnode_0><![CDATA[0]]></subnode_0>
    </ErrorCode>
    <SessionID><![CDATA[759ekrt4efgolvtnqifboi7b00]]></SessionID>
    <Subscribers>
        <subnode_0>
            <SubscriberID><![CDATA[3374]]></SubscriberID>
            <EmailAddress><![CDATA[am2089339@acme.co.za]]></EmailAddress>
            <BounceType><![CDATA[Not Bounced]]></BounceType>
            <SubscriptionStatus><![CDATA[Subscribed]]></SubscriptionStatus>
            <SubscriptionDate><![CDATA[2008-02-04]]></SubscriptionDate>
            <SubscriptionIP><![CDATA[85.105.238.88 - Imported]]></SubscriptionIP>
            <UnsubscriptionDate><![CDATA[0000-00-00]]></UnsubscriptionDate>
            <UnsubscriptionIP><![CDATA[0.0.0.0]]></UnsubscriptionIP>
            <OptInDate><![CDATA[0000-00-00]]></OptInDate>
            <CustomField59><![CDATA[]]></CustomField59>
        </subnode_0>
        <subnode_1>
            <SubscriberID><![CDATA[5744]]></SubscriberID>
            <EmailAddress><![CDATA[23092dummy@acme.com]]></EmailAddress>
            <BounceType><![CDATA[Not Bounced]]></BounceType>
            <SubscriptionStatus><![CDATA[Subscribed]]></SubscriptionStatus>
            <SubscriptionDate><![CDATA[2008-02-04]]></SubscriptionDate>
            <SubscriptionIP><![CDATA[85.105.238.88 - Imported]]></SubscriptionIP>
            <UnsubscriptionDate><![CDATA[0000-00-00]]></UnsubscriptionDate>
            <UnsubscriptionIP><![CDATA[0.0.0.0]]></UnsubscriptionIP>
            <OptInDate><![CDATA[0000-00-00]]></OptInDate>
            <CustomField59><![CDATA[Dummy Name]]></CustomField59>
        </subnode_1>
    </Subscribers>
</response>