/projects/:document_identifier/reports/:report_uuid/recipients

This resource supports the GET method.

URL Parameters

Label	Description
:document_identifier	The project's document identifier
:report_uuid	The UUID of the report

GET

Returns an array of all the recipients of this campaign. If the campaign contains more than 1000 recipients, the results will be paginated. See "Pagination" in the Getting Started guide for more information.

GET Request Query String Parameters

Name	Required	Description
fields	No	A comma-separated list of the keys you want returned for each recipient. Default is to return all keys.

GET Response Status Codes

Code	Description
503 Service Unavailable	Server is undergoing maintenance and is unavailable
429 Rate Limited	Rate limiting in effect, try again later
404 Not Found	The resource could not be found or your API key has not been granted access to it
403 Forbidden	Direct Mail account is disabled
401 Unauthorized	API key, secret, or authentication method is incorrect
200 OK	Success

GET Response Headers

Name	Description
X-Total-Count	The total number of recipients

GET Response Body

JSON representation of an array of objects. Each object in the array represents a recipient. Please consult the /projects/:document_identifier/reports/:report_uuid/recipients/:recipient_uuid resource for a description of the object keys for each recipient.

GET Example

GET /api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients HTTP/1.1
Authorization: Basic QzFENDREMjEtNTA4MC00NTM3LUFFOD
Accept: application/json; charset=utf-8
Host: secure.directmailmac.com

HTTP/1.1 200 OK
Date: Thu, 23 Apr 2015 23:22:29 GMT
Content-Type: application/json; charset=utf-8
X-Total-Count: 758

[
    {
        "bounce_reason": null,
        "bounced_hard": false,
        "bounced_soft": false,
        "email": "user101@example.com",
        "failed": false,
        "failure_description": null,
        "links": [
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A",
                "rel": "self"
            },
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/archived-address",
                "rel": "archived-address"
            },
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/live-address",
                "rel": "live-address"
            },
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/opens",
                "rel": "opens"
            },
            {
                "href": "https://secure.directmailmac.com/api/v2/projects/187812f26ba37d9769d8691d2a83c95c/reports/F4B2E4E6-B94F-462C-AFEC-1F9497BA98A0/recipients/E336DC4B-43BA-45B6-9290-14568D8A431A/clicks",
                "rel": "clicks"
            }
        ],
        "number_of_clicks": 0,
        "number_of_opens": 1,
        "reported_spam_complaint": false,
        "send_date": "2015-04-23T22:53:48+0000",
        "sent": true,
        "spam_complaint_date": null,
        "unsubscribe_date": null,
        "unsubscribed": false,
        "uuid": "E336DC4B-43BA-45B6-9290-14568D8A431A"
    },
    ...truncated....
]