Get information about all recipients in a recipient list

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}

Get detailed information about all recipients in a recipient list, such as recipient ID, creation date and modification date.Request limit: In total, a maximum of 10 simultaneous requests for the following operations are permitted per client: REST API selectRecipients, REST API countRecipients and SOAP API getCount (RecipientWebservice).

Path Parameters

clientIdinteger<int64>required
Description
Client ID
Format
int64
recipientListIdinteger<int64>required
Description
Recipient list ID
Format
int64

Query Parameters

offsetinteger<int32>
Description
Starting point of the result list Default value : 0
Format
int32
limitinteger<int32>
Description
Maximum number of recipients Default value : 100
Format
int32
targetGroupinteger<int64>
Description
ID of the matching target group
Format
int64
attributeNamesstring[]
Description
Comma-separated names of the fields whose recipient data is to be retrieved. Example: "firstname,lastname". Note: You must use the internal names of the recipient list fields. To retrieve the attribute names of a recipient list, use the Recipient lists operation GET /recipientlists/{recipientListId}/attributeNames.
includeOptinDataboolean
Description
Specify whether the opt-in data fields should be returned. Only applicable for opt-in list
sortstring
Description
Sort result by specific criteria
Default
id
directionstring
Description
Sort order
Default
ASC
Allowed
ASCDESC

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/vnd.optivo.broadmail.v1+json

Responses

200All relevant recipients were retrieved successfully.

RestRecipientStreamingCollection
- elementsRestRecipient[]
  - idstring
    Description
    Recipient ID
  - createdstring<date-time>
    Description
    Creation date
    Format
    date-time
  - modifiedstring<date-time>
    Description
    Modification date
    Format
    date-time
  - optInMailIdstring
    Description
    Mail ID in case of double/confirmed opt-in process
  - linksobject[]
    Description
    Restful links
    - uriBuilderobject
    - relsstring[]
    - relstring
    - typestring
    - paramsmap<string, string>
    - titlestring
    - uristring<uri>
      Format
      uri
- countinteger<int32>
  Format
  int32
- offsetinteger<int32>
  Format
  int32
- limitinteger<int32>
  Format
  int32

429Too many requests are used at the same time to retrieve recipients.

curl

curl --request GET \
     --url 'https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}?sort=id&direction=ASC' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}?sort=id&direction=ASC", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}?sort=id&direction=ASC")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.campaign.episerver.net/rest/{clientId}/recipients/{recipientListId}?sort=id&direction=ASC"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// All relevant recipients were retrieved successfully.
{
  "elements": [
    {
      "id": "",
      "created": "",
      "modified": "",
      "optInMailId": "",
      "links": [
        {
          "uriBuilder": {},
          "rels": [
            ""
          ],
          "rel": "",
          "type": "",
          "params": "",
          "title": "",
          "uri": ""
        }
      ]
    }
  ],
  "count": "",
  "offset": "",
  "limit": ""
}

429

// Too many requests are used at the same time to retrieve recipients.