GET restapi/personal/messages/v1?UseNewerThan={UseNewerThan}&FromId={FromId}&PageIndex={PageIndex}&PageSize={PageSize}

Gets the user's messages.

Supports paging. If paging is not used, it will use a default pageSize on pageIndex 0.

The client can specify paging with a combination of UseNewerThan and FromId to be able to page directly from a specified messageId.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UseNewerThan

boolean

None.

FromId

integer

None.

PageIndex

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

List of MessagePreview entities

EntityListOfItslearning.RestApi.Entities.MessagePreview
NameDescriptionTypeAdditional information
EntityArray

Collection of Itslearning.RestApi.Entities.MessagePreview

None.

Total

integer

None.

CurrentPageIndex

integer

None.

PageSize

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityArray": [
    {
      "MessageId": 1,
      "From": {
        "PersonId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "FullName": "sample string 4",
        "ProfileUrl": "sample string 5",
        "AdditionalInfo": "sample string 6",
        "ProfileImageUrl": "sample string 7",
        "ProfileImageUrlSmall": "sample string 8"
      },
      "DateReceived": "2025-06-25T13:21:02Z",
      "Subject": "sample string 3",
      "PreviewText": "sample string 4",
      "MessageUrl": "sample string 5",
      "ContentUrl": "sample string 6",
      "HasAttachments": true,
      "IsRead": true,
      "IsForwarded": true,
      "LastForwardedDateTime": "2025-06-25T13:21:02Z",
      "IsReplied": true,
      "LastRepliedDateTime": "2025-06-25T13:21:02Z"
    },
    {
      "MessageId": 1,
      "From": {
        "PersonId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "FullName": "sample string 4",
        "ProfileUrl": "sample string 5",
        "AdditionalInfo": "sample string 6",
        "ProfileImageUrl": "sample string 7",
        "ProfileImageUrlSmall": "sample string 8"
      },
      "DateReceived": "2025-06-25T13:21:02Z",
      "Subject": "sample string 3",
      "PreviewText": "sample string 4",
      "MessageUrl": "sample string 5",
      "ContentUrl": "sample string 6",
      "HasAttachments": true,
      "IsRead": true,
      "IsForwarded": true,
      "LastForwardedDateTime": "2025-06-25T13:21:02Z",
      "IsReplied": true,
      "LastRepliedDateTime": "2025-06-25T13:21:02Z"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:
<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <MessagePreview>
      <ContentUrl>sample string 6</ContentUrl>
      <DateReceived>2025-06-25T13:21:02Z</DateReceived>
      <From>
        <AdditionalInfo>sample string 6</AdditionalInfo>
        <FirstName>sample string 2</FirstName>
        <FullName>sample string 4</FullName>
        <LastName>sample string 3</LastName>
        <PersonId>1</PersonId>
        <ProfileImageUrl>sample string 7</ProfileImageUrl>
        <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
        <ProfileUrl>sample string 5</ProfileUrl>
      </From>
      <HasAttachments>true</HasAttachments>
      <IsForwarded>true</IsForwarded>
      <IsRead>true</IsRead>
      <IsReplied>true</IsReplied>
      <LastForwardedDateTime>2025-06-25T13:21:02Z</LastForwardedDateTime>
      <LastRepliedDateTime>2025-06-25T13:21:02Z</LastRepliedDateTime>
      <MessageId>1</MessageId>
      <MessageUrl>sample string 5</MessageUrl>
      <PreviewText>sample string 4</PreviewText>
      <Subject>sample string 3</Subject>
    </MessagePreview>
    <MessagePreview>
      <ContentUrl>sample string 6</ContentUrl>
      <DateReceived>2025-06-25T13:21:02Z</DateReceived>
      <From>
        <AdditionalInfo>sample string 6</AdditionalInfo>
        <FirstName>sample string 2</FirstName>
        <FullName>sample string 4</FullName>
        <LastName>sample string 3</LastName>
        <PersonId>1</PersonId>
        <ProfileImageUrl>sample string 7</ProfileImageUrl>
        <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
        <ProfileUrl>sample string 5</ProfileUrl>
      </From>
      <HasAttachments>true</HasAttachments>
      <IsForwarded>true</IsForwarded>
      <IsRead>true</IsRead>
      <IsReplied>true</IsReplied>
      <LastForwardedDateTime>2025-06-25T13:21:02Z</LastForwardedDateTime>
      <LastRepliedDateTime>2025-06-25T13:21:02Z</LastRepliedDateTime>
      <MessageId>1</MessageId>
      <MessageUrl>sample string 5</MessageUrl>
      <PreviewText>sample string 4</PreviewText>
      <Subject>sample string 3</Subject>
    </MessagePreview>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>