Loading ...

REST API: Get Sent Emails | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Get Sent Emails
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 7

REST API: Get Sent Emails

0 
 /5
0 (0votes)
Open API Guide
GET/api/sent-emails

Get a list of the emails the site has sent, one page at a time. You can filter it by date range and sort it by send date. Use it for reporting, auditing, or copying sent email data to other systems.

Request

Request Header

Header Required Value Description
Authorization YES Bearer YOUR_TOKEN Bearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

Parameter Type Required Location Description
StartPage Integer YES Query Page of results to return
PageLength Integer YES Query Number of results to return per page

Optional Parameters

Parameter Type Required Location Description
StartDate String NO Query Filters results to emails sent on or after this date/time (inclusive). Use ISO 8601 format (e.g. 2025-02-10 or 2025-02-10T00:00:00Z).
EndDate String NO Query Filters results to emails sent on or before this date/time (inclusive). Use ISO 8601 format (e.g. 2025-02-10 or 2025-02-10T23:59:59Z). A date with no time means midnight at the start of that day.
SortOrder String NO Query Sort direction for DateSent. 0 = ascending, 1 = descending. Default: 1. The names Ascending and Descending also work; any other value sorts newest first.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/sent-emails?StartPage=1&PageLength=10&SortOrder=1

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "TotalRecords": 776,
  "ResponseData": [
    {
      "LogID": 49149,
      "EmailTo": "jane.doe@your-site.com",
      "EmailFrom": "community@your-site.com",
      "EmailSubject": "Marketing: new wall post",
      "DateSent": "2026-09-13T02:06:11.317Z",
      "EmailToUserID": 804,
      "SendStatus": "Success",
      "TenantID": 1
    }
  ]
}

Error Response

startPage and pageLength are required

Error Handling

Status Code Likely Cause Next Action
400 Bad Request StartPage or PageLength is missing, either is 0 or less, or StartDate or EndDate cannot be read as a date; the message says which. Send both paging values greater than 0, and dates in ISO 8601 format.
401 Unauthorized Missing or invalid Bearer token. Check token validity. Learn how to create Bearer tokens →
403 Forbidden The caller is not a site administrator. Only site administrators can read the sent email log. Call as a site administrator.
500 Server Error Internal failure. Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages