Inventories
Users

List Inventory Items

Changed on

List 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.
get/cloud/v2/users/{user_id}/inventory-items

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/users/{user_id}/inventory-items
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token

Path parameters

user_idstring required

The user ID.

Query parameters

maxPageSizeinteger

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.

pageTokenstring

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.
filterstring

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

nextPageTokenstring

A token that you can send as a pageToken parameter to retrieve the next page. If this field is omitted, there are no subsequent pages.

Changes

    • breaking

      for the query request parameter maxPageSize, default value was changed from 0 to 10

    • breaking

      for the query request parameter maxPageSize, default value 0 was added

    • breaking

      the response property // became nullable for the status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to 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 property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status