v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get Group Instances

Returns a list of group instances

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

GET
/groups/{groupId}/instances

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Response Body

application/json

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000/instances"
[
  {
    "instanceId": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
    "location": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
    "world": {
      "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "authorName": "string",
      "capacity": 8,
      "recommendedCapacity": 4,
      "created_at": "2019-08-24T14:15:22Z",
      "defaultContentSettings": {
        "drones": true,
        "emoji": true,
        "pedestals": true,
        "prints": true,
        "stickers": true,
        "props": true
      },
      "description": "string",
      "favorites": 12024,
      "featured": false,
      "heat": 5,
      "id": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
      "imageUrl": "string",
      "instances": [
        [
          null,
          null
        ]
      ],
      "labsPublicationDate": "none",
      "name": "string",
      "namespace": "string",
      "occupants": 47,
      "organization": "vrchat",
      "popularity": 8,
      "previewYoutubeId": "string",
      "privateOccupants": 1,
      "publicOccupants": 46,
      "publicationDate": "none",
      "releaseStatus": "public",
      "storeId": "esto_713b247d-2b5d-41a0-bba3-50db28dc1498",
      "tags": [
        "string"
      ],
      "thumbnailImageUrl": "string",
      "unityPackages": [
        {
          "id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
          "assetUrl": "https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file",
          "assetUrlObject": {},
          "assetVersion": 4,
          "created_at": "2020-09-10T06:13:27.777Z",
          "impostorizerVersion": "0.17.0",
          "performanceRating": "Excellent",
          "platform": "standalonewindows",
          "pluginUrl": "",
          "pluginUrlObject": {},
          "unitySortNumber": 20180414000,
          "unityVersion": "2022.3.6f1",
          "worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ==",
          "impostorUrl": "string",
          "scanStatus": "string",
          "variant": "string"
        }
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "urlList": [
        "string"
      ],
      "version": 68,
      "visits": 9988675,
      "udonProducts": [
        "prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
      ]
    },
    "memberCount": 6
  }
]

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

{
  "error": {
    "message": "Can't find groupǃ",
    "status_code": 404
  }
}