API.fetchSubscriptionSubscribers - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

API.fetchSubscriptionSubscribers

From Calaméo Knowledge Base

Note: This action is only available to PREMIUM and PLATINUM members. Click Here To Upgrade.

This action allows you to fetch a subscription's subscribers.

Contents

Request

The API key must have the subscribers_read access right.
Name Required Type Description
apikey yes string API public key
signature yes string Signature of the request. See How To Sign Your Requests.
expires yes timestamp UNIX timestamp for request expiration (GMT).
output string Format of the response. Either XML (default), JSON or PHP.
subscription_id yes integer ID of the subscription.
order string String of characters used to define the organization criteria of the subscribers (see sorting)
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.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      total: ...,
      start: ...,
      step: ...,
      items: [
         {
            AccountID: ...,
            SubscriptionID: ...,
            LastName: ...,
            FirstName: ...,
            Email: ...,
            Login: ...,
            Password: ...,
            IsActive: ...,
            Creation: ...,
            Modification: ...,
            LastLogin: ...,
            Extras: ...,
         }
      ]
    }
  }
}

Error codes

See the Error Codes.