v6 documentation is incomplete, want to contribute?

Get Product Listing

Gets a product listing

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

GET
/listing/{productId}
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

productIdstring

Must be a valid product ID.

Query Parameters

hydrate?boolean

Populates some fields and changes types of others for certain objects.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/listing/string?hydrate=true"
{
  "active": true,
  "buyerRefundable": true,
  "description": "string",
  "displayName": "string",
  "duration": 0,
  "durationType": "string",
  "groupIcon": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
  "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "groupName": "string",
  "hasAvatar": true,
  "hasUdon": true,
  "hydratedProducts": [
    {
      "archived": true,
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "displayName": "string",
      "groupAccess": false,
      "groupAccessRemove": false,
      "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
      "groupRoleId": "grol_459d3911-f672-44bc-b84d-e54ffe7960fe",
      "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
      "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
      "parentListings": [
        "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
      ],
      "productType": "listing",
      "sellerDisplayName": "string",
      "sellerId": "string",
      "tags": [
        "string"
      ],
      "updated": "2019-08-24T14:15:22Z",
      "useForSubscriberList": false
    }
  ],
  "id": "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4",
  "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
  "imageUrl": "string",
  "listingType": "subscription",
  "listingVariants": [
    {
      "effectiveFrom": "2019-08-24T14:15:22Z",
      "listingVariantId": "listvar_e8658b56-1662-436c-935a-afcf6a7d4fed",
      "nonRefundable": true,
      "quantity": 0,
      "sellerVariant": true,
      "unitPriceTokens": 0
    }
  ],
  "permanent": true,
  "priceTokens": 0,
  "productIds": [
    "prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4"
  ],
  "productType": "listing",
  "products": [
    {}
  ],
  "quantifiable": true,
  "recurrable": true,
  "refundable": true,
  "sellerDisplayName": "string",
  "sellerId": "string",
  "stackable": true,
  "storeIds": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

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