API.fetchSubscriptionSubscribers
This action allows you to fetch a subscription's subscribers.
Request
The API key must have the subscribers_read access right.
| Name | Type | Description |
|---|---|---|
| apikey[required] | string | API public key |
| signature[required] | string | Signature of the request. See how to sign your requests. |
| expires | timestamp | UNIX timestamp for request expiration. |
| output | string | Format of the response. Either XML (default), JSON or PHP. |
| subscription_id[required] | 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
<response>
<requestid>...</requestid>
<requests>...</requests>
<status>ok</status>
<content>
<total>...</total>
<start>...</start>
<step>...</step>
<items>
<item>
<AccountID>...</AccountID>
<SubscriptionID>...</SubscriptionID>
<LastName>...</LastName>
<FirstName>...</FirstName>
<Email>...</Email>
<Login>...</Login>
<Password>...</Password>
<IsActive>...</IsActive>
<Creation>...</Creation>
<Modification>...</Modification>
<LastLogin>...</LastLogin>
<Extras>...</Extras>
</item>
</items>
</content>
</response>
{
"response": {
"requestid": ...,
"requests": ...,
"status": "ok",
"content": {
"total": ...,
"start": ...,
"step": ...,
"items": [
{
"AccountID": ...,
"SubscriptionID": ...,
"LastName": ...,
"FirstName": ...,
"Email": ...,
"Login": ...,
"Password": ...,
"IsActive": ...,
"Creation": ...,
"Modification": ...,
"LastLogin": ...,
"Extras": ...,
}
]
}
}
}
[
"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 code section.
