Away 10:47 PM

2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

InventoryItem — openapi

Represents an item in a user's inventory.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the inventory item. Format: users/{user_id}/inventory-items/{inventory_item_id}
assetDetailsfalsePopulated if this item is an asset.
badgeDetailsfalsePopulated if this item is a badge.
gamePassDetailsfalsePopulated if this item is a game pass.
privateServerDetailsfalsePopulated if this item is a private server.
addTimestringfalseThe time when the item was added to the user's inventory. For example, the time when the user purchased a private server or was awarded a badge. This field is currently not populated for passes.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The resource path of the inventory item.\r\n            \r\nFormat: `users/{user_id}/inventory-items/{inventory_item_id}`"
    },
    "assetDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InventoryItem_AssetDetails"
        }
      ],
      "description": "Populated if this item is an asset."
    },
    "badgeDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InventoryItem_BadgeDetails"
        }
      ],
      "description": "Populated if this item is a badge."
    },
    "gamePassDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InventoryItem_GamePassDetails"
        }
      ],
      "description": "Populated if this item is a game pass."
    },
    "privateServerDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InventoryItem_PrivateServerDetails"
        }
      ],
      "description": "Populated if this item is a private server."
    },
    "addTime": {
      "type": "string",
      "description": "The time when the item was added to the user's inventory. For example, the\r\ntime when the user purchased a private server or was awarded a badge.\r\n            \r\nThis field is currently not populated for passes.",
      "format": "date-time",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Represents an item in a user's inventory."
}