v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get Inventory

Returns an Inventory object.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/inventory

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

n?integer

The number of objects to return.

Default60
Range1 <= value <= 100
offset?integer

A zero-based offset from the default object sorting from where search results start.

Range0 <= value
order?string

Sort order for inventory retrieval.

Value in"newest" | "newest_created" | "oldest" | "oldest_created"
tags?string

Filter tags for inventory retrieval (comma-separated).

Length1 <= length
types?string

Filter for inventory retrieval.

Default"bundle"
Value in"bundle" | "prop" | "emoji" | "sticker"
flags?string

Filter flags for inventory retrieval (comma-separated).

Default"instantiatable"
Value in"instantiatable" | "archivable" | "consumable" | "trashable" | "cloneable" | "ugc"
notTypes?string

Filter out types for inventory retrieval (comma-separated).

Default"bundle"
Value in"bundle" | "prop" | "emoji" | "sticker"
notFlags?string

Filter out flags for inventory retrieval (comma-separated).

Default"instantiatable"
Value in"instantiatable" | "archivable" | "consumable" | "trashable" | "cloneable" | "ugc"
archived?boolean

Filter archived status for inventory retrieval.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/inventory?n=60&offset=0&order=newest&tags=string&types=prop&flags=consumable&notTypes=prop&notFlags=consumable&archived=true"
{
  "data": [
    {
      "collections": [
        "string"
      ],
      "created_at": "2025-06-13T05:00:45.455Z",
      "description": "string",
      "expiryDate": "2025-06-13T05:00:45.455Z",
      "flags": [
        "string"
      ],
      "holderId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "id": "inv_10bce5b0-2d2b-44e0-900d-db6534615162",
      "imageUrl": "string",
      "isArchived": true,
      "isSeen": true,
      "itemType": "prop",
      "itemTypeLabel": "string",
      "metadata": {
        "inventoryItemsToInstantiate": [
          "invt_b80ce14b-038b-4f56-b970-d232771d62e3"
        ],
        "animated": true,
        "animationStyle": "string",
        "assetBundleId": "string",
        "fileId": "string",
        "imageUrl": "string",
        "maskTag": "string",
        "propId": "prop_829ba6f6-b837-49d9-b9a9-056b82103b58"
      },
      "name": "string",
      "tags": [
        "string"
      ],
      "templateId": "invt_b80ce14b-038b-4f56-b970-d232771d62e3",
      "template_created_at": "2025-06-09T16:31:40.785Z",
      "template_updated_at": "2025-06-25T00:34:14.578Z",
      "updated_at": "2025-06-25T00:34:15.965Z"
    }
  ],
  "totalCount": 0
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}