GET v1/Emails/List?entityId={entityId}&policyId={policyId}&searchWhat={searchWhat}&orderBy={orderBy}&sortDirection={sortDirection}&pageNumber={pageNumber}&pageSize={pageSize}

Returns a paginated list of sent emails, scoped to a contact/entity or a policy.

Request Information

URI Parameters

Name	Description	Type	Additional information
entityId	The ID of the entity (e.g. contact) to retrieve emails for. Required unless is supplied. Ignored when is provided.	integer	None.
policyId	Optional. When provided, returns emails associated with this policy instead of the entity, regardless of the value.	integer	None.
searchWhat	Optional. Contains-match against the email's Subject, EmailAccount, an address in Addresses[], the Assignments[].AssignedBy name, or an Assignments[].Tags value. When the term parses as a date (MMddyyyy or MM/dd/yyyy) it also matches the email's date.	string	None.
orderBy	Column to sort results by. Defaults to Date. Each value maps to a field on the returned as noted below. Date (default) — sorts by the email's Date.AssignedBy — sorts by the assignment's Assignments[].AssignedBy name.AssignedDate — sorts by the assignment's Assignments[].AssignedDateTime. Any other value falls back to Date.	string	Default value is Date
sortDirection	Sort direction. Defaults to DESC. ASCDESC (default)	string	Default value is DESC
pageNumber	Page number to return. Defaults to 1.	integer	Default value is 1
pageSize	Number of records per page. Defaults to 25.	integer	Default value is 25

Body Parameters

None.

Response Information

Resource Description

Paginated list of .

PageOfOfEmailListItemDTO

Name	Type	Additional information
Data	Collection of EmailListItemDTO	None.
PageNumber	integer	None.
PagesTotal	integer	None.
TotalItems	integer	None.
IsSuccess	boolean	None.
ErrorCode	string	None.
ErrorMessage	string	None.
DisplayMessage	string	None.
Links	Collection of PageLink	None.
Href	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": [
    {
      "ID": 1,
      "UID": 1,
      "Subject": "sample string 2",
      "Date": "2026-09-08T09:41:08.7588859+00:00",
      "DateAdded": "2026-09-08T09:41:08.7588859+00:00",
      "EmailAccount": "sample string 4",
      "CampaignName": "sample string 5",
      "HasAttachment": true,
      "Addresses": [
        {
          "Address": "sample string 1",
          "AddressType": "sample string 2"
        },
        {
          "Address": "sample string 1",
          "AddressType": "sample string 2"
        }
      ],
      "Assignments": [
        {
          "EntityID": 1,
          "AssignedBy": "sample string 2",
          "AssignedDateTime": "2026-09-08T09:41:08.7588859+00:00",
          "Description": "sample string 4",
          "Tags": [
            "sample string 1",
            "sample string 2"
          ],
          "PolicyIDs": [
            1,
            2
          ]
        },
        {
          "EntityID": 1,
          "AssignedBy": "sample string 2",
          "AssignedDateTime": "2026-09-08T09:41:08.7588859+00:00",
          "Description": "sample string 4",
          "Tags": [
            "sample string 1",
            "sample string 2"
          ],
          "PolicyIDs": [
            1,
            2
          ]
        }
      ],
      "Attachments": [
        {
          "ID": 1,
          "BlobInfoID": 1,
          "AcordFormId": 1,
          "FileName": "sample string 2",
          "ContentType": "sample string 3",
          "DisplayName": "sample string 4",
          "BlobUrl": "sample string 5"
        },
        {
          "ID": 1,
          "BlobInfoID": 1,
          "AcordFormId": 1,
          "FileName": "sample string 2",
          "ContentType": "sample string 3",
          "DisplayName": "sample string 4",
          "BlobUrl": "sample string 5"
        }
      ]
    },
    {
      "ID": 1,
      "UID": 1,
      "Subject": "sample string 2",
      "Date": "2026-09-08T09:41:08.7588859+00:00",
      "DateAdded": "2026-09-08T09:41:08.7588859+00:00",
      "EmailAccount": "sample string 4",
      "CampaignName": "sample string 5",
      "HasAttachment": true,
      "Addresses": [
        {
          "Address": "sample string 1",
          "AddressType": "sample string 2"
        },
        {
          "Address": "sample string 1",
          "AddressType": "sample string 2"
        }
      ],
      "Assignments": [
        {
          "EntityID": 1,
          "AssignedBy": "sample string 2",
          "AssignedDateTime": "2026-09-08T09:41:08.7588859+00:00",
          "Description": "sample string 4",
          "Tags": [
            "sample string 1",
            "sample string 2"
          ],
          "PolicyIDs": [
            1,
            2
          ]
        },
        {
          "EntityID": 1,
          "AssignedBy": "sample string 2",
          "AssignedDateTime": "2026-09-08T09:41:08.7588859+00:00",
          "Description": "sample string 4",
          "Tags": [
            "sample string 1",
            "sample string 2"
          ],
          "PolicyIDs": [
            1,
            2
          ]
        }
      ],
      "Attachments": [
        {
          "ID": 1,
          "BlobInfoID": 1,
          "AcordFormId": 1,
          "FileName": "sample string 2",
          "ContentType": "sample string 3",
          "DisplayName": "sample string 4",
          "BlobUrl": "sample string 5"
        },
        {
          "ID": 1,
          "BlobInfoID": 1,
          "AcordFormId": 1,
          "FileName": "sample string 2",
          "ContentType": "sample string 3",
          "DisplayName": "sample string 4",
          "BlobUrl": "sample string 5"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:

<PageOfEmailListItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Emails">
    <d2p1:EmailListItemDTO>
      <d2p1:Addresses>
        <d2p1:EmailListAddressDTO>
          <d2p1:Address>sample string 1</d2p1:Address>
          <d2p1:AddressType>sample string 2</d2p1:AddressType>
        </d2p1:EmailListAddressDTO>
        <d2p1:EmailListAddressDTO>
          <d2p1:Address>sample string 1</d2p1:Address>
          <d2p1:AddressType>sample string 2</d2p1:AddressType>
        </d2p1:EmailListAddressDTO>
      </d2p1:Addresses>
      <d2p1:Assignments>
        <d2p1:EmailListAssignmentDTO>
          <d2p1:AssignedBy>sample string 2</d2p1:AssignedBy>
          <d2p1:AssignedDateTime>2026-09-08T09:41:08.7588859+00:00</d2p1:AssignedDateTime>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:EntityID>1</d2p1:EntityID>
          <d2p1:PolicyIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </d2p1:PolicyIDs>
          <d2p1:Tags xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d2p1:Tags>
        </d2p1:EmailListAssignmentDTO>
        <d2p1:EmailListAssignmentDTO>
          <d2p1:AssignedBy>sample string 2</d2p1:AssignedBy>
          <d2p1:AssignedDateTime>2026-09-08T09:41:08.7588859+00:00</d2p1:AssignedDateTime>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:EntityID>1</d2p1:EntityID>
          <d2p1:PolicyIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </d2p1:PolicyIDs>
          <d2p1:Tags xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d2p1:Tags>
        </d2p1:EmailListAssignmentDTO>
      </d2p1:Assignments>
      <d2p1:Attachments>
        <d2p1:EmailListAttachmentDTO>
          <d2p1:AcordFormId>1</d2p1:AcordFormId>
          <d2p1:BlobInfoID>1</d2p1:BlobInfoID>
          <d2p1:BlobUrl>sample string 5</d2p1:BlobUrl>
          <d2p1:ContentType>sample string 3</d2p1:ContentType>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:FileName>sample string 2</d2p1:FileName>
          <d2p1:ID>1</d2p1:ID>
        </d2p1:EmailListAttachmentDTO>
        <d2p1:EmailListAttachmentDTO>
          <d2p1:AcordFormId>1</d2p1:AcordFormId>
          <d2p1:BlobInfoID>1</d2p1:BlobInfoID>
          <d2p1:BlobUrl>sample string 5</d2p1:BlobUrl>
          <d2p1:ContentType>sample string 3</d2p1:ContentType>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:FileName>sample string 2</d2p1:FileName>
          <d2p1:ID>1</d2p1:ID>
        </d2p1:EmailListAttachmentDTO>
      </d2p1:Attachments>
      <d2p1:CampaignName>sample string 5</d2p1:CampaignName>
      <d2p1:Date>2026-09-08T09:41:08.7588859+00:00</d2p1:Date>
      <d2p1:DateAdded>2026-09-08T09:41:08.7588859+00:00</d2p1:DateAdded>
      <d2p1:EmailAccount>sample string 4</d2p1:EmailAccount>
      <d2p1:HasAttachment>true</d2p1:HasAttachment>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Subject>sample string 2</d2p1:Subject>
      <d2p1:UID>1</d2p1:UID>
    </d2p1:EmailListItemDTO>
    <d2p1:EmailListItemDTO>
      <d2p1:Addresses>
        <d2p1:EmailListAddressDTO>
          <d2p1:Address>sample string 1</d2p1:Address>
          <d2p1:AddressType>sample string 2</d2p1:AddressType>
        </d2p1:EmailListAddressDTO>
        <d2p1:EmailListAddressDTO>
          <d2p1:Address>sample string 1</d2p1:Address>
          <d2p1:AddressType>sample string 2</d2p1:AddressType>
        </d2p1:EmailListAddressDTO>
      </d2p1:Addresses>
      <d2p1:Assignments>
        <d2p1:EmailListAssignmentDTO>
          <d2p1:AssignedBy>sample string 2</d2p1:AssignedBy>
          <d2p1:AssignedDateTime>2026-09-08T09:41:08.7588859+00:00</d2p1:AssignedDateTime>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:EntityID>1</d2p1:EntityID>
          <d2p1:PolicyIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </d2p1:PolicyIDs>
          <d2p1:Tags xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d2p1:Tags>
        </d2p1:EmailListAssignmentDTO>
        <d2p1:EmailListAssignmentDTO>
          <d2p1:AssignedBy>sample string 2</d2p1:AssignedBy>
          <d2p1:AssignedDateTime>2026-09-08T09:41:08.7588859+00:00</d2p1:AssignedDateTime>
          <d2p1:Description>sample string 4</d2p1:Description>
          <d2p1:EntityID>1</d2p1:EntityID>
          <d2p1:PolicyIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>1</d6p1:int>
            <d6p1:int>2</d6p1:int>
          </d2p1:PolicyIDs>
          <d2p1:Tags xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </d2p1:Tags>
        </d2p1:EmailListAssignmentDTO>
      </d2p1:Assignments>
      <d2p1:Attachments>
        <d2p1:EmailListAttachmentDTO>
          <d2p1:AcordFormId>1</d2p1:AcordFormId>
          <d2p1:BlobInfoID>1</d2p1:BlobInfoID>
          <d2p1:BlobUrl>sample string 5</d2p1:BlobUrl>
          <d2p1:ContentType>sample string 3</d2p1:ContentType>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:FileName>sample string 2</d2p1:FileName>
          <d2p1:ID>1</d2p1:ID>
        </d2p1:EmailListAttachmentDTO>
        <d2p1:EmailListAttachmentDTO>
          <d2p1:AcordFormId>1</d2p1:AcordFormId>
          <d2p1:BlobInfoID>1</d2p1:BlobInfoID>
          <d2p1:BlobUrl>sample string 5</d2p1:BlobUrl>
          <d2p1:ContentType>sample string 3</d2p1:ContentType>
          <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
          <d2p1:FileName>sample string 2</d2p1:FileName>
          <d2p1:ID>1</d2p1:ID>
        </d2p1:EmailListAttachmentDTO>
      </d2p1:Attachments>
      <d2p1:CampaignName>sample string 5</d2p1:CampaignName>
      <d2p1:Date>2026-09-08T09:41:08.7588859+00:00</d2p1:Date>
      <d2p1:DateAdded>2026-09-08T09:41:08.7588859+00:00</d2p1:DateAdded>
      <d2p1:EmailAccount>sample string 4</d2p1:EmailAccount>
      <d2p1:HasAttachment>true</d2p1:HasAttachment>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:Subject>sample string 2</d2p1:Subject>
      <d2p1:UID>1</d2p1:UID>
    </d2p1:EmailListItemDTO>
  </Data>
  <DisplayMessage>sample string 7</DisplayMessage>
  <ErrorCode>sample string 5</ErrorCode>
  <ErrorMessage>sample string 6</ErrorMessage>
  <Href>sample string 8</Href>
  <IsSuccess>true</IsSuccess>
  <Links>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
    <PageLink>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
    </PageLink>
  </Links>
  <PageNumber>1</PageNumber>
  <PagesTotal>2</PagesTotal>
  <TotalItems>3</TotalItems>
</PageOfEmailListItemDTO>