The Email list resource represents e-mails that have been sent in a given agency.
HTTP GET
GET /api/2013-12-01/Emails/[Agency ID]
Returns a list of sent emails for the given [Agency ID].
Paging
Paging can be accomplished by passing the page request parameter. By default only 100 objects are returned per request. You can use the page_size request parameter to specify up to 10,000 objects per request.
List Filters
The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.
| Parameter | Description |
|---|---|
| Email_ID | Only show emails who’s Email ID matches the provided information. |
| User_ID | Only show emails that have been sent from a specific user. |
| Subject | Only show emails that contain the given Subject |
| From_Email | Only show emails sent from the given e-mail address |
Example Request
Fetch the entire list.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Emails/[Agency ID] \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2015-09-21T15:39:22+00:00",
"objects": [
{
"Email ID": 1,
"Sent": 1407266196,
"Subject": "Test",
"From": {
"User ID": 1,
"Name": "John Doe",
"Email": "john@readyop.com"
}
}
],
"results": 1,
"pages": 1,
"page": 0,
"page_start": 0,
"page_end": 0,
"page_size": 100
}