GET api/v2.0/Messaging/GetInboxMessages?firstRecord={firstRecord}&maxRecords={maxRecords}

Retrieves all Inbox Messages for the Current User.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
firstRecord

integer

Default value is 0

maxRecords

integer

Default value is 50

Body Parameters

None.

Response Information

Resource Description

List of Mailbox Messages.

Collection of MailboxMessage
NameDescriptionTypeAdditional information
MessageKey

globally unique identifier

None.

FromContactKey

globally unique identifier

None.

SentOn

date

None.

Subject

string

None.

Message

string

None.

IsInSentBox

boolean

None.

IsRead

boolean

None.

FromFirstName

string

None.

FromLastName

string

None.

FromDisplayName

string

None.

LinkToSenderProfile

string

None.

ToContactKey

globally unique identifier

None.

ToFirstName

string

None.

ToLastName

string

None.

ToDisplayName

string

None.

LinkToRecipientProfile

string

None.

LinkToRecipientSmallImage

string

None.

LinkToRecipientLargeImage

string

None.

LinkToSenderSmallImage

string

None.

LinkToSenderLargeImage

string

None.

IsSenderCompany

boolean

None.

IsRecipientCompany

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "MessageKey": "99d6c25c-2c5f-434c-bc67-7c25d74219b3",
    "FromContactKey": "33cc410b-80ae-40a2-b93c-0ea591ed9136",
    "SentOn": "2019-05-25T20:04:11.2581432Z",
    "Subject": "sample string 4",
    "Message": "sample string 5",
    "IsInSentBox": true,
    "IsRead": true,
    "FromFirstName": "sample string 8",
    "FromLastName": "sample string 9",
    "FromDisplayName": "sample string 10",
    "LinkToSenderProfile": "sample string 11",
    "ToContactKey": "80b73bc5-6297-4c6c-b0b4-1ac9f39d7041",
    "ToFirstName": "sample string 13",
    "ToLastName": "sample string 14",
    "ToDisplayName": "sample string 15",
    "LinkToRecipientProfile": "sample string 16",
    "LinkToRecipientSmallImage": "sample string 17",
    "LinkToRecipientLargeImage": "sample string 18",
    "LinkToSenderSmallImage": "sample string 19",
    "LinkToSenderLargeImage": "sample string 20",
    "IsSenderCompany": true,
    "IsRecipientCompany": true
  },
  {
    "MessageKey": "99d6c25c-2c5f-434c-bc67-7c25d74219b3",
    "FromContactKey": "33cc410b-80ae-40a2-b93c-0ea591ed9136",
    "SentOn": "2019-05-25T20:04:11.2581432Z",
    "Subject": "sample string 4",
    "Message": "sample string 5",
    "IsInSentBox": true,
    "IsRead": true,
    "FromFirstName": "sample string 8",
    "FromLastName": "sample string 9",
    "FromDisplayName": "sample string 10",
    "LinkToSenderProfile": "sample string 11",
    "ToContactKey": "80b73bc5-6297-4c6c-b0b4-1ac9f39d7041",
    "ToFirstName": "sample string 13",
    "ToLastName": "sample string 14",
    "ToDisplayName": "sample string 15",
    "LinkToRecipientProfile": "sample string 16",
    "LinkToRecipientSmallImage": "sample string 17",
    "LinkToRecipientLargeImage": "sample string 18",
    "LinkToSenderSmallImage": "sample string 19",
    "LinkToSenderLargeImage": "sample string 20",
    "IsSenderCompany": true,
    "IsRecipientCompany": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfMailboxMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <MailboxMessage>
    <FromContactKey>33cc410b-80ae-40a2-b93c-0ea591ed9136</FromContactKey>
    <FromDisplayName>sample string 10</FromDisplayName>
    <FromFirstName>sample string 8</FromFirstName>
    <FromLastName>sample string 9</FromLastName>
    <IsInSentBox>true</IsInSentBox>
    <IsRead>true</IsRead>
    <IsRecipientCompany>true</IsRecipientCompany>
    <IsSenderCompany>true</IsSenderCompany>
    <LinkToRecipientLargeImage>sample string 18</LinkToRecipientLargeImage>
    <LinkToRecipientProfile>sample string 16</LinkToRecipientProfile>
    <LinkToRecipientSmallImage>sample string 17</LinkToRecipientSmallImage>
    <LinkToSenderLargeImage>sample string 20</LinkToSenderLargeImage>
    <LinkToSenderProfile>sample string 11</LinkToSenderProfile>
    <LinkToSenderSmallImage>sample string 19</LinkToSenderSmallImage>
    <Message>sample string 5</Message>
    <MessageKey>99d6c25c-2c5f-434c-bc67-7c25d74219b3</MessageKey>
    <SentOn>2019-05-25T20:04:11.2581432Z</SentOn>
    <Subject>sample string 4</Subject>
    <ToContactKey>80b73bc5-6297-4c6c-b0b4-1ac9f39d7041</ToContactKey>
    <ToDisplayName>sample string 15</ToDisplayName>
    <ToFirstName>sample string 13</ToFirstName>
    <ToLastName>sample string 14</ToLastName>
  </MailboxMessage>
  <MailboxMessage>
    <FromContactKey>33cc410b-80ae-40a2-b93c-0ea591ed9136</FromContactKey>
    <FromDisplayName>sample string 10</FromDisplayName>
    <FromFirstName>sample string 8</FromFirstName>
    <FromLastName>sample string 9</FromLastName>
    <IsInSentBox>true</IsInSentBox>
    <IsRead>true</IsRead>
    <IsRecipientCompany>true</IsRecipientCompany>
    <IsSenderCompany>true</IsSenderCompany>
    <LinkToRecipientLargeImage>sample string 18</LinkToRecipientLargeImage>
    <LinkToRecipientProfile>sample string 16</LinkToRecipientProfile>
    <LinkToRecipientSmallImage>sample string 17</LinkToRecipientSmallImage>
    <LinkToSenderLargeImage>sample string 20</LinkToSenderLargeImage>
    <LinkToSenderProfile>sample string 11</LinkToSenderProfile>
    <LinkToSenderSmallImage>sample string 19</LinkToSenderSmallImage>
    <Message>sample string 5</Message>
    <MessageKey>99d6c25c-2c5f-434c-bc67-7c25d74219b3</MessageKey>
    <SentOn>2019-05-25T20:04:11.2581432Z</SentOn>
    <Subject>sample string 4</Subject>
    <ToContactKey>80b73bc5-6297-4c6c-b0b4-1ac9f39d7041</ToContactKey>
    <ToDisplayName>sample string 15</ToDisplayName>
    <ToFirstName>sample string 13</ToFirstName>
    <ToLastName>sample string 14</ToLastName>
  </MailboxMessage>
</ArrayOfMailboxMessage>