fetchAccountSubscribers

This action allows you to fetch your Account's subscribers.

info

The API key must have access rights to subscribers_read.

Request

Name		Type	Description
apikey	Required	string	API public key
signature	Required	string	Signature of the request.
expires		timestamp	UNIX timestamp for request expiration (GMT)
output		string	Format of the response. Either XML (default), JSON or PHP
order		string	String of characters used to define the organization criteria of the subscribers
way		string	String of characters used to define the sort order. Either UP (default) or DOWN
start		integer	Start position of the range of subscribers. Default is 0
step		integer	Number of subscribers to be sent from the start position (max: 50)

Response

This method returns an array of Subscribers.

Name	Type	Description
AccountID	integer	Subscriber's owner account ID (should be your account ID)
SubscriptionID	integer	Subscriber's folder ID
LastName	string	Last name of the subscriber
FirstName	string	First name of the subscriber
Email	string	Email address of the subscriber
Login	string	Login of the subscriber
Password	string	Password of the subscriber
IsActive	boolean	Activation status of the subscriber. Either 1 (activated), 0 (deactivated)
HasFullAccess	boolean	Full access to the subscription. Either 1 (activated), 0 (deactivated)
LastLogin	datetime	Date of the subscriber's last login
Creation	datetime	Date the subscriber was created
Modification	datetime	Date the subscriber was last edited
Extras	string	Additional information on the subscriber, in varchar format up to 255 characters in size

Example response

JSON

{
  "response": {
    "status": "ok",
    "version": 2,
    "requestid": "NIwM0j",
    "requests": 163,
    "content": {
      "total": 1,
      "start": 0,
      "step": 10,
      "items": [
        {
          "AccountID": 4516825,
          "SubscriptionID": 4540112,
          "LastName": "",
          "FirstName": "",
          "Email": "",
          "Login": "leia",
          "Password": "syCo3hJN",
          "IsActive": 0,
          "HasFullAccess": 0,
          "LastLogin": false,
          "Creation": "2015-10-16 11:31:05",
          "Modification": "2015-10-16 11:31:05",
          "Extras": ""
        }
      ]
    }
  }
}