E-Mails

Get paginated collection of E-Mail log entries

Get paginated E-Mail log entries. <br> You can use different query parameters to filter the E-Mail logs

get/pimcore-studio/api/emails

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/emails
  • Auth: none declared

Query parameters

pageinteger required
Example:1

Page number

pageSizeinteger required
Example:10

Number of items per page

Response

Paginated E-Mail log entries with total count as header param

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "id": 23,
      "sentDate": 1707312457,
      "hasHtmlLog": true,
      "hasTextLog": true,
      "hasError": true,
      "from": "from@pimcore.com",
      "to": "to@pimcore.com",
      "subject": "E-Mail subject"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.