List Inventory Items
Changed onList the inventory items in a user's inventory.
The inventory items returned depend on the target user’s choice under Settings > Privacy > Who can see my inventory?:
- If the user granted inventory visibility to "Everyone," then any API key or OAuth2 token can be used to view the target’s inventory, no matter what scopes it has or who created it.
- If the user has not granted inventory visibility to "Everyone":
- Their inventory can still be viewed with an API key created by the target user with Inventory: Read permission.
- Their inventory can still be viewed with an OAuth2 token if the target user authorizes an app requesting permissions for the user.inventory-item:read scope.
Request
- Base URLhttps://apis.roblox.com
- URLhttps://apis.roblox.com/cloud/v2/users/{user_id}/inventory-items
- Auth
- API key in header x-api-key
- or OAuth 2Authorization code: https://apis.roblox.com/oauth/v1/authorizeToken URL: https://apis.roblox.com/oauth/v1/token
Path parameters
The user ID.
Query parameters
The maximum number of inventory items to return. The service might return fewer than this value. If unspecified, at most 10 inventory items are returned. The maximum value is 100 and higher values are set to 100.
A page token, received from a previous call, to retrieve a subsequent page.
When paginating, all other parameters provided to the subsequent call must
match the call that provided the page token.
This field may be set in order to filter the resources returned.
See the
[filtering](/cloud/reference/patterns#list-inventory-items)
documentation for more information.
Response
OK
Changes
- breaking
for the
queryrequest parametermaxPageSize, default value was changed from0to10
- breaking
- breaking
for the
queryrequest parametermaxPageSize, default value0was added - breaking
the response property
//became nullable for the status - breaking
the
//response's property type changed fromobjectto no type for status - breaking
the
//response's property type changed fromobjectto no type for status - breaking
the
//response's property type changed fromobjectto no type for status - breaking
the
//response's property type changed fromobjectto no type for status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status - info
the response optional property
//became not read-only for the status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status - info
added to the
//response propertyallOflist for the response status
- breaking