v6 documentation is incomplete, want to contribute?

Get World Metadata

Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with updateWorld and can be any arbitrary object.

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

GET
/worlds/{worldId}/metadata
auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

worldIdstring

Must be a valid world ID.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/worlds/string/metadata"
{
  "id": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "metadata": {}
}

{
  "error": {
    "message": "World wrld_ba913a96-fac4-4048-a062-9aa5db092812 not found",
    "status_code": 404
  }
}