Skip to main content

GET (/users/xuid()/inbox/)

Retrieves the detailed message text for a particular user message, marking it as read on the service. The domain for these URIs is msg.xboxlive.com.

Remarks

The get operation can only be performed on the User, System, and FriendRequest message types. This URI requires a refresh on Xbox.com. Currently, the XBOX 360 will not update the read/unread state until a user signs out and back in. The only content type this API supports is “application/json”, which is required in the HTTP headers of each call.

URI parameters

Authorization

You must have your own user claim to retrieve a user message.

Request body

No objects are sent in the body of this request.

Effect of privacy settings on resource

Only you can retrieve your own user messages.

HTTP status codes

The service returns one of the status codes in this section in response to a request made with this method on this resource. For a complete list of standard HTTP status codes used with XBOX Live Services, see Standard HTTP status codes. | Code| Description| | --- | --- | --- | --- | --- | | 200| Success.| | 400| The XUID cannot be converted properly.| | 403| The XUID cannot be converted or a valid XUID claim cannot be found.| | 404| A valid XUID is missing, or the message ID cannot be found or is parsed incorrectly.| | 500| General server-side error, or the message type is not valid for GET.|

JavaScript Object Notation (JSON) Response

If called successfully, the service returns the results data in a JSON format. The root object is a UserMessageHeader object.

UserMessageHeader

Sample response

Error Response

In case of error, the service may return an errorResponse object, which may contain values from the environment of the service. | Property| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | errorSource| string| An indication of where the error originated.| | errorCode| int| Numeric code associated with the error (can be null).| | errorMessage| string| Details of the error if configured to show details.|

See also

Parent
/users/xuid()/inbox
Reference Standard HTTP status codes
Last modified on August 20, 2026