GET (/users/xuid(xuid)/lists/PINS/)
Returns the contents of a list. The domain for these URIs iseplists.xboxlive.com.
- Remarks
- URI parameters
- Query string parameters
- Authorization
- Required Request Headers
- Request body
- HTTP status codes
- Response body
Remarks
The listCount field in the data returned indicates how many items are in the total list maintained by the service — as such, it can be used to determine where the end of the list is, and this is potentially a different number from how many specific items were returned by the request. If the list does not yet exist, then the results will contain no list items, the listCount will be zero and the listVersion will be zero.URI parameters
Query string parameters
| Parameter| Type| Description| | --- | --- | --- | --- | --- | --- | | skipItems| 32-bit signed integer| Optional. Number of items to skip in the enumeration before returning results. Default value: 0.| | maxItems| 32-bit signed integer| Optional. Maximum number of items to return. The default is 25 items if no maximum is specified in the request. The service does not place a maximum on this value; if the value is greater than the number of items in the list, then all items will be returned with no error.| | filterItemId| string| Optional. Specifies the item to find in the list. Returns all instances of the item in the list. Allows the client to quickly determine if and where an item is in a list. Handy for large lists to determine all instances of an item without iterating through the entire list. Default value: null.| | filterContentType| string| Optional. Specifies a comma-separated list of content types to return (will not return types not in the list). Used to only get certain content types from a list. A comma-separated list of content types is used for this filter. (Multiple content types can be queried in one call.) Content types supported include all the media types defined by Entertainment Discovery Services (EDS). Default value: null (all content types).| | filterDeviceType| string| Optional. Specifies a comma-separated list of device types to return (will not return types not in the list). Filters the return set to only return items which have been inserted from a specific set of device types. A comma-separated list of device types is used for this filter (multiple device types can be queried in one call). Possible values: XboxOne, MCapensis, WindowsPhone, WindowsPhone7, Web, PC, MoLive. Default value: null (all content types).|Authorization
This call expects an XSTS SAML token in the Authorization header. A Xuid claim must exist within that SAML token to identify the caller. This value is used to determine if the caller has access rights to the list data in question. The list itself will be identified by the Xuid as well and will be included in the URI for the list. Using this, we may in the future support shared access to lists, but that is not a feature at this time. Currently, all lists that a user accesses will be their own and there is no shared access. Thus the Xuid in the URI must match the Xuid in the SAML claims token.Note:
Both XBL Auth 2.0 and 3.0 tokens are supported at present.