API Reference

List Email Recipients

Returns a list of Recipients for a specific Email.

Request

POST https://api.platform.ly

Method: list_email_recipients

Request Body

{
  "api_key":"xxxxxxxxxxxxx",           //required
  "action": "list_email_recipients",   //required
  "value": {
    "email_id": 0,                     //required
    "filter": "",
    "page": 0                    
  }
}

curl --location --request POST 'https://api.platform.ly' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'api_key=xxxxxxxxxxxxx' \
--data-urlencode 'action=list_email_recipients' \
--data-urlencode 'value={"email_id": "0","filter":"opened","page": "0"}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.platform.ly',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'api_key=xxxxxxxxxxxxx&action=list_email_recipients&value=%7B%22email_id%22%3A%20%220%22%2C%22filter%22%3A%22opened%22%2C%22page%22%3A%20%220%22%7D',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


import requests

url = "https://api.platform.ly"

payload='api_key=xxxxxxxxxxxxx&action=list_email_recipients&value=%7B%22email_id%22%3A%20%220%22%2C%22filter%22%3A%22opened%22%2C%22page%22%3A%20%220%22%7D'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "api_key=xxxxxxxxxxxxx&action=list_email_recipients&value={\"email_id\": \"0\",\"filter\":\"opened\",\"page\": \"0\"}");
Request request = new Request.Builder()
  .url("https://api.platform.ly")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();

Request Format

api_key required
Authentication API Key. Where can I find my API Key?

action required
list_email_recipients

value required
JSON formatted string with additional request values

email_id required
Email ID. Where can I find my Project ID?

filter optional
Filter recipients by behaviour.
Allowed values: opened, not_opened, clicked, not_clicked.

page optional
The response contains 100 results per page.

Response

Returns a JSON contacts object or an empty object (when there are no contacts) if the request succeeded. Returns an error if the request parameters are invalid.

👍

200 OK

[
    {
        "date": 1599477264,
        "contact_id": 0,
        "first_name": "John",
        "last_name": "Smith",
        "email": "[email protected]"
    },
    {
        "date": 1599814028,
        "contact_id": 1,
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]"
    }
]