GET api/v1.0/Messaging/GetInboxMessages?firstRecord={firstRecord}&maxRecords={maxRecords}
Retrieves all Inbox Messages for the Current User.
Request Information
URI Parameters
Name | Description | Type | Additional 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 MailboxMessageName | Description | Type | Additional 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": "d67ac5de-34ee-46f4-8338-db8009d4adf5", "FromContactKey": "94f980ed-6eb3-4f6d-89ff-cf8c7e00a728", "SentOn": "2024-09-08T02:49:29.0350013Z", "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": "084732a3-6627-4afc-ae69-ea4c0d3db118", "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": "d67ac5de-34ee-46f4-8338-db8009d4adf5", "FromContactKey": "94f980ed-6eb3-4f6d-89ff-cf8c7e00a728", "SentOn": "2024-09-08T02:49:29.0350013Z", "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": "084732a3-6627-4afc-ae69-ea4c0d3db118", "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>94f980ed-6eb3-4f6d-89ff-cf8c7e00a728</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>d67ac5de-34ee-46f4-8338-db8009d4adf5</MessageKey> <SentOn>2024-09-08T02:49:29.0350013Z</SentOn> <Subject>sample string 4</Subject> <ToContactKey>084732a3-6627-4afc-ae69-ea4c0d3db118</ToContactKey> <ToDisplayName>sample string 15</ToDisplayName> <ToFirstName>sample string 13</ToFirstName> <ToLastName>sample string 14</ToLastName> </MailboxMessage> <MailboxMessage> <FromContactKey>94f980ed-6eb3-4f6d-89ff-cf8c7e00a728</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>d67ac5de-34ee-46f4-8338-db8009d4adf5</MessageKey> <SentOn>2024-09-08T02:49:29.0350013Z</SentOn> <Subject>sample string 4</Subject> <ToContactKey>084732a3-6627-4afc-ae69-ea4c0d3db118</ToContactKey> <ToDisplayName>sample string 15</ToDisplayName> <ToFirstName>sample string 13</ToFirstName> <ToLastName>sample string 14</ToLastName> </MailboxMessage> </ArrayOfMailboxMessage>