Skip to main content

GET (/users/xuid()/inbox)

Retrieves a specified number of user message summaries from the service. The domain for these URIs is msg.xboxlive.com.

Remarks

A user message summary contains only the message subject. For user-generated messages, this is currently the first 20 characters of the message text. System messages may provide an alternate subject, such as “LIVE System”. Messages are returned in the reverse of the order they were sent; that is, newer messages are returned first. The only content type this API supports is “application/json”, which is required in the HTTP headers of each call.

URI parameters

Query string parameters

| Property| Type| Maximum Length| Remarks| | --- | --- | --- | --- | --- | --- | --- | | maxItems| int| 100| Maximum number of messages returned.| | continuationToken| string| | String returned in a previous enumeration call; used to continue enumeration.| | skipItems| int| 100| Number of messages to skip; ignored if continuationToken is present.|

Authorization

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

Effect of privacy settings on resource

Only you can enumerate 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| The request was successful.| | 400| Service could not understand malformed request. Typically an invalid parameter.| | 403| The request is not allowed for the user or service.| | 404| A valid XUID is missing in the URI.| | 409| The underlying collection changed based on the continuation token that was passed.| | 416| The number of items to skip is larger than the number of available items.| | 500| General server-side error.|

JavaScript Object Notation (JSON) Response

If called successfully, the service returns the results data in a JSON format.

Message

Paging Info

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