< Back to main page

GET {who}/Messages?language={language}

Gets all messages for the given 'who'. These can optionally be retrieved in the language specified.

Request Information

Parameters

NameDescriptionAdditional information
who Who to retrieve messages for. Valid values are "my", or an organization number of an organization the user can represent, or <Reportee.ReporteeId>, where the identified reportee may be a person or organization.

Define this parameter in the request URI.
queryOptions The supplied ODataQueryOptions (if any).

None.
language Translation of messages retrieved, valid values are: 1033 (English), 1044 (Bokmal) and 2068 (Nynorsk) This is an optional parameter, defaults to the user preset language.

Define this parameter in the request URI.

Response Information

All messages for the requested user.

Response body formats

application/hal+xml

Sample:

Sample not available.

application/hal+json

Sample: 
{
  "_links": {
    "self": {
      "href": "sample string 93"
    }
  },
  "_embedded": {
    "sample string 62": [
      {
        "MessageId": "sample string 83",
        "OriginalId": "sample string 37",
        "Subject": "sample string 85",
        "Status": "sample string 72",
        "MarkedUnread": true,
        "LastChangedDateTime": "2025-03-19T10:21:38.3381126+01:00",
        "CreatedDate": "2025-03-19T10:21:38.3381126+01:00",
        "LastChangedBy": "sample string 46",
        "ServiceOwner": "sample string 46",
        "Type": "sample string 33",
        "MessageSender": "sample string 40",
        "Summary": "sample string 18",
        "Body": "sample string 17",
        "ServiceCode": "sample string 19",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2025-03-19T10:21:38.3381126+01:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 21",
        "ReplyOptions": [
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          },
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          },
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          }
        ],
        "_links": {
          "self": {
            "href": "sample string 89"
          }
        }
      },
      {
        "MessageId": "sample string 83",
        "OriginalId": "sample string 37",
        "Subject": "sample string 85",
        "Status": "sample string 72",
        "MarkedUnread": true,
        "LastChangedDateTime": "2025-03-19T10:21:38.3381126+01:00",
        "CreatedDate": "2025-03-19T10:21:38.3381126+01:00",
        "LastChangedBy": "sample string 46",
        "ServiceOwner": "sample string 46",
        "Type": "sample string 33",
        "MessageSender": "sample string 40",
        "Summary": "sample string 18",
        "Body": "sample string 17",
        "ServiceCode": "sample string 19",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2025-03-19T10:21:38.3381126+01:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 21",
        "ReplyOptions": [
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          },
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          },
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          }
        ],
        "_links": {
          "self": {
            "href": "sample string 89"
          }
        }
      },
      {
        "MessageId": "sample string 83",
        "OriginalId": "sample string 37",
        "Subject": "sample string 85",
        "Status": "sample string 72",
        "MarkedUnread": true,
        "LastChangedDateTime": "2025-03-19T10:21:38.3381126+01:00",
        "CreatedDate": "2025-03-19T10:21:38.3381126+01:00",
        "LastChangedBy": "sample string 46",
        "ServiceOwner": "sample string 46",
        "Type": "sample string 33",
        "MessageSender": "sample string 40",
        "Summary": "sample string 18",
        "Body": "sample string 17",
        "ServiceCode": "sample string 19",
        "ServiceEdition": 16,
        "SignatureSpec": {
          "FormIds": [
            1,
            2,
            3
          ],
          "AttachmentIds": [
            1,
            2,
            3
          ]
        },
        "DueDate": "2025-03-19T10:21:38.3381126+01:00",
        "AvailableAction": 0,
        "ArchiveReference": "sample string 21",
        "ReplyOptions": [
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          },
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          },
          {
            "Type": "sample string 82",
            "URL": "sample string 35",
            "Text": "sample string 22"
          }
        ],
        "_links": {
          "self": {
            "href": "sample string 89"
          }
        }
      }
    ]
  }
}