v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get User Group Instances

Returns a list of group instances for a user

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

GET
/users/{userId}/instances/groups

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

userIdstring

Must be a valid user ID.

Response Body

application/json

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/users/string/instances/groups"
{
  "fetchedAt": "2019-08-24T14:15:22Z",
  "instances": [
    {
      "active": true,
      "ageGate": true,
      "canRequestInvite": true,
      "capacity": 8,
      "clientNumber": "string",
      "contentSettings": {
        "drones": true,
        "emoji": true,
        "pedestals": true,
        "prints": true,
        "stickers": true,
        "props": true
      },
      "displayName": "string",
      "full": false,
      "gameServerVersion": 0,
      "id": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
      "instanceId": "12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
      "instancePersistenceEnabled": "string",
      "location": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)",
      "n_users": 6,
      "name": "12345",
      "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "permanent": false,
      "photonRegion": "eu",
      "platforms": {
        "android": 1,
        "ios": 1,
        "standalonewindows": 5
      },
      "playerPersistenceEnabled": true,
      "region": "us",
      "secureName": "7eavhhng",
      "shortName": "02u7yz8j",
      "tags": [
        "show_social_rank",
        "language_eng",
        "language_jpn"
      ],
      "type": "hidden",
      "worldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
      "hidden": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "friends": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "private": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "queueEnabled": true,
      "queueSize": 6,
      "recommendedCapacity": 6,
      "roleRestricted": true,
      "strict": true,
      "userCount": 6,
      "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"
        ]
      },
      "users": [
        {
          "ageVerificationStatus": "hidden",
          "ageVerified": true,
          "allowAvatarCopying": true,
          "bio": "string",
          "bioLinks": [
            "string"
          ],
          "currentAvatarImageUrl": "https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file",
          "currentAvatarThumbnailImageUrl": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
          "currentAvatarTags": [
            "string"
          ],
          "date_joined": "2019-08-24T14:15:22Z",
          "developerType": "none",
          "displayName": "string",
          "friendKey": "string",
          "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
          "isFriend": true,
          "imageUrl": "string",
          "last_platform": "standalonewindows",
          "last_activity": "2019-08-24T14:15:22Z",
          "last_mobile": "2019-08-24T14:15:22Z",
          "platform": "string",
          "profilePicOverride": "string",
          "profilePicOverrideThumbnail": "string",
          "pronouns": "string",
          "state": "offline",
          "status": "active",
          "statusDescription": "string",
          "tags": [
            "string"
          ],
          "userIcon": "string"
        }
      ],
      "groupAccessType": "members",
      "hasCapacityForYou": true,
      "nonce": "string",
      "closedAt": "2019-08-24T14:15:22Z",
      "hardClose": true
    }
  ]
}

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

{
  "error": {
    "message": "User ID must be your own․",
    "status_code": 403
  }
}