Skip to main content

fetchAccountSubscriptions

This action allows you to recover all or part of the Folders belonging to your Account.

info

The API key must have access rights to commons.

Request​

NameTypeDescription
apikeyRequiredstringAPI public key
signatureRequiredstringSignature of the request.
expirestimestampUNIX timestamp for request expiration (GMT)
outputstringFormat of the response. Either XML (default), JSON or PHP
orderstringString of characters used to define the organization criteria of the folders.
waystringString of characters used to define the sort order. Either UP (default) or DOWN
startintegerStart position of the range of folders. Default is 0
stepintegerNumber of folders to be sent from the start position (max: 50)

Response​

This method returns an array of Folders.

NameTypeDescription
IDintegerUnique identifying key for the folder
AccountIDintegerUnique identifying key for the account of the folder
NamestringTitle of the folder
DescriptionstringDescription of the folder
BooksintegerAvailable publications inside the folder
SubscribersintegerAvailable subscribers inside the folder (only returned for your account's folder)
CreationdatetimeDate of the folder's creation
ModificationdatetimeDate of the folder's last modification
PublicUrlstringAbsolute URL for the folder's overview

Example response​

JSON
{
"response": {
"status": "ok",
"version": 2,
"requestid": "EGNNi2",
"requests": 162,
"content": {
"total": 1,
"start": 0,
"step": 10,
"items": [
{
"ID": 4540112,
"AccountID": 4516825,
"Name": "Mon dossier",
"Description": "",
"Books": 0,
"Subscribers": 0,
"Creation": "2015-10-06 16:55:39",
"Modification": "2015-10-06 16:55:39",
"PublicUrl": "https://www.calameo.com/subscriptions/4540112"
}
]
}
}
}