Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

Subscribers.Get

Description

Retrieves subscribers of a subscriber list.

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {Subscribers.Get} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP

OrderField = {string} (required)

Name of the field to order based on

OrderType = {ASC | DESC} (required)

Ascending or descending ordering

RecordsFrom = {integer} (required)

Start from (starts from zero)

RecordsPerRequest = {integer} (required)

How many rows to return per page

SearchField = {string} (required)

Subscriber list field to make the search. Leave empty to disable search

SearchKeyword = {string} (required)

The keyword to search in subscriber list database. Leave empty to disable search

SubscriberListID = {integer} (required)

List ID of the subscribers

SubscriberSegment = {mixed} (required)

Target segment ID or one of the following values: Suppressed, Unsubscribed, Soft bounced, Hard bounced, Opt-in pending, Active.

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

ErrorText = {text}

Subscribers = {array}

Returns the list of all subscribers in array

TotalSubscribers = {integer}

Returns the total number of subscribers

Error Codes

1

Missing subscriber list ID

2

Target segment ID is missing

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!