GET /cloud/v2/users/{user_id}/inventory-items — openapi

List Inventory Items

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.

Endpoint

Method: GET

Path: /cloud/v2/users/{user_id}/inventory-items

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
user_id	path	true	The user ID.
maxPageSize	query	false	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.
pageToken	query	false	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.
filter	query	false	This field may be set in order to filter the resources returned. See the filtering documentation for more information.

[
  {
    "name": "user_id",
    "in": "path",
    "description": "The user ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of inventory items to return. The service might return\r\n             fewer than this value. If unspecified, at most 10 inventory items are\r\n             returned. The maximum value is 100 and higher values are set to 100.",
    "schema": {
      "type": "integer",
      "format": "int32",
      "default": 10
    }
  },
  {
    "name": "pageToken",
    "in": "query",
    "description": "A page token, received from a previous call, to retrieve a subsequent page.\r\n            \r\n             When paginating, all other parameters provided to the subsequent call must\r\n             match the call that provided the page token.",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "filter",
    "in": "query",
    "description": "This field may be set in order to filter the resources returned.\r\n            \r\n             See the\r\n             [filtering](/cloud/reference/patterns#list-inventory-items)\r\n             documentation for more information.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	Success

{
  "200": {
    "description": "Success",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ListInventoryItemsResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

ListInventoryItemsResponse

Complete Operation Definition

{
  "tags": [
    "Inventories",
    "Users"
  ],
  "summary": "List Inventory Items",
  "description": "List the inventory items in a user's inventory.\r\n            \r\nThe inventory items returned depend on the target user’s choice under\r\n**Settings > Privacy > Who can see my inventory?**:\r\n* If the user granted inventory visibility to \"Everyone,\" then any API key\r\nor OAuth2 token can be used to view the target’s inventory, no matter what\r\nscopes it has or who created it.\r\n* If the user has not granted inventory visibility to \"Everyone\":\r\n  * Their inventory can still be viewed with an API key created by the\r\n  target user with **Inventory: Read** permission.\r\n  * Their inventory can still be viewed with an OAuth2 token if the target\r\n  user authorizes an app requesting permissions for the\r\n  `user.inventory-item:read` scope.",
  "operationId": "Cloud_ListInventoryItems",
  "parameters": [
    {
      "name": "user_id",
      "in": "path",
      "description": "The user ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of inventory items to return. The service might return\r\n             fewer than this value. If unspecified, at most 10 inventory items are\r\n             returned. The maximum value is 100 and higher values are set to 100.",
      "schema": {
        "type": "integer",
        "format": "int32",
        "default": 10
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "A page token, received from a previous call, to retrieve a subsequent page.\r\n            \r\n             When paginating, all other parameters provided to the subsequent call must\r\n             match the call that provided the page token.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "filter",
      "in": "query",
      "description": "This field may be set in order to filter the resources returned.\r\n            \r\n             See the\r\n             [filtering](/cloud/reference/patterns#list-inventory-items)\r\n             documentation for more information.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Success",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListInventoryItemsResponse"
          }
        }
      }
    }
  },
  "x-roblox-scopes": [
    {
      "name": "user.inventory-item:read",
      "description": "Required to read the target user's own private inventory; not required for public inventories."
    }
  ],
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 20
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/inventories#Cloud_ListInventoryItems"
  }
}