GET v1/emails?SortBy={SortBy}&IsSortAscending={IsSortAscending}&Page={Page}&PageSize={PageSize}&ToUserId={ToUserId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SortBy

string

None.

IsSortAscending

boolean

None.

Page

integer

None.

PageSize

integer

None.

ToUserId

globally unique identifier

None.

IsDraft

boolean

None.

Body Parameters

None.

Response Information

Resource Description

Collection of EmailResponse
NameDescriptionTypeAdditional information
EmailId

globally unique identifier

None.

SenderId

globally unique identifier

None.

ToUserId

globally unique identifier

None.

Body

string

None.

CreatedOn

date

None.

UpdatedBy

globally unique identifier

None.

UpdatedOn

date

None.

MessageType

integer

None.

EmailDraft

boolean

None.

EmailSubject

string

None.

SenderName

string

None.

SenderUserName

string

None.

SenderImageUrl

string

None.

RecipientName

string

None.

RecipientUserName

string

None.

RecipientImageUrl

string

None.

Attachments

Collection of EmailAttachment

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "emailId": "c302da56-3fc3-4580-9a76-a007674ef1e0",
    "senderId": "5fbcb639-cb48-4ac6-83df-a323d4890825",
    "toUserId": "1ec12ec2-87d8-4268-b92d-bc419e21b112",
    "body": "sample string 3",
    "createdOn": "2024-09-13T04:46:13.5870916Z",
    "updatedBy": "003d86f6-ce08-4137-bd0b-2f64c7ddbce3",
    "updatedOn": "2024-09-13T04:46:13.5870916Z",
    "messageType": 1,
    "emailDraft": true,
    "emailSubject": "sample string 5",
    "senderName": "sample string 6",
    "senderUserName": "sample string 7",
    "senderImageUrl": "sample string 8",
    "recipientName": "sample string 9",
    "recipientUserName": "sample string 10",
    "recipientImageUrl": "sample string 11",
    "attachments": [
      {
        "dataUrl": "sample string 1",
        "dataSize": 1,
        "thumbnailUrl": "sample string 2",
        "fileName": "sample string 3"
      },
      {
        "dataUrl": "sample string 1",
        "dataSize": 1,
        "thumbnailUrl": "sample string 2",
        "fileName": "sample string 3"
      }
    ]
  },
  {
    "emailId": "c302da56-3fc3-4580-9a76-a007674ef1e0",
    "senderId": "5fbcb639-cb48-4ac6-83df-a323d4890825",
    "toUserId": "1ec12ec2-87d8-4268-b92d-bc419e21b112",
    "body": "sample string 3",
    "createdOn": "2024-09-13T04:46:13.5870916Z",
    "updatedBy": "003d86f6-ce08-4137-bd0b-2f64c7ddbce3",
    "updatedOn": "2024-09-13T04:46:13.5870916Z",
    "messageType": 1,
    "emailDraft": true,
    "emailSubject": "sample string 5",
    "senderName": "sample string 6",
    "senderUserName": "sample string 7",
    "senderImageUrl": "sample string 8",
    "recipientName": "sample string 9",
    "recipientUserName": "sample string 10",
    "recipientImageUrl": "sample string 11",
    "attachments": [
      {
        "dataUrl": "sample string 1",
        "dataSize": 1,
        "thumbnailUrl": "sample string 2",
        "fileName": "sample string 3"
      },
      {
        "dataUrl": "sample string 1",
        "dataSize": 1,
        "thumbnailUrl": "sample string 2",
        "fileName": "sample string 3"
      }
    ]
  }
]

text/html, multipart/form-data

Sample:
[{"emailId":"c302da56-3fc3-4580-9a76-a007674ef1e0","senderId":"5fbcb639-cb48-4ac6-83df-a323d4890825","toUserId":"1ec12ec2-87d8-4268-b92d-bc419e21b112","body":"sample string 3","createdOn":"2024-09-13T04:46:13.5870916Z","updatedBy":"003d86f6-ce08-4137-bd0b-2f64c7ddbce3","updatedOn":"2024-09-13T04:46:13.5870916Z","messageType":1,"emailDraft":true,"emailSubject":"sample string 5","senderName":"sample string 6","senderUserName":"sample string 7","senderImageUrl":"sample string 8","recipientName":"sample string 9","recipientUserName":"sample string 10","recipientImageUrl":"sample string 11","attachments":[{"dataUrl":"sample string 1","dataSize":1,"thumbnailUrl":"sample string 2","fileName":"sample string 3"},{"dataUrl":"sample string 1","dataSize":1,"thumbnailUrl":"sample string 2","fileName":"sample string 3"}]},{"emailId":"c302da56-3fc3-4580-9a76-a007674ef1e0","senderId":"5fbcb639-cb48-4ac6-83df-a323d4890825","toUserId":"1ec12ec2-87d8-4268-b92d-bc419e21b112","body":"sample string 3","createdOn":"2024-09-13T04:46:13.5870916Z","updatedBy":"003d86f6-ce08-4137-bd0b-2f64c7ddbce3","updatedOn":"2024-09-13T04:46:13.5870916Z","messageType":1,"emailDraft":true,"emailSubject":"sample string 5","senderName":"sample string 6","senderUserName":"sample string 7","senderImageUrl":"sample string 8","recipientName":"sample string 9","recipientUserName":"sample string 10","recipientImageUrl":"sample string 11","attachments":[{"dataUrl":"sample string 1","dataSize":1,"thumbnailUrl":"sample string 2","fileName":"sample string 3"},{"dataUrl":"sample string 1","dataSize":1,"thumbnailUrl":"sample string 2","fileName":"sample string 3"}]}]