v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get Group by ID

Returns a single Group by ID.

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

GET
/groups/{groupId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Query Parameters

includeRoles?boolean

Include roles for the Group object. Defaults to false.

Response Body

application/json

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000?includeRoles=true"
{
  "ageVerificationSlotsAvailable": true,
  "ageVerificationBetaCode": "abc1234",
  "ageVerificationBetaSlots": 500,
  "badges": [
    "string"
  ],
  "id": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
  "name": "string",
  "shortCode": "ABC123",
  "discriminator": "1234",
  "description": "string",
  "iconUrl": "string",
  "bannerUrl": "string",
  "privacy": "default",
  "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "rules": "string",
  "links": [
    "string"
  ],
  "languages": [
    "string"
  ],
  "iconId": "string",
  "bannerId": "string",
  "memberCount": 0,
  "memberCountSyncedAt": "2019-08-24T14:15:22Z",
  "isVerified": false,
  "joinState": "closed",
  "tags": [
    "string"
  ],
  "transferTargetId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "galleries": [
    {
      "id": "ggal_a03a4b55-4ca6-4490-9519-40ba6351a233",
      "name": "Example Gallery",
      "description": "Example Description",
      "membersOnly": false,
      "roleIdsToView": [
        "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
      ],
      "roleIdsToSubmit": [
        "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
      ],
      "roleIdsToAutoApprove": [
        "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
      ],
      "roleIdsToManage": [
        "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "lastPostCreatedAt": "2019-08-24T14:15:22Z",
  "onlineMemberCount": 0,
  "membershipStatus": "member",
  "myMember": {
    "id": "gmem_95cdb3b4-4643-4eb6-bdab-46a4e1e5ce37",
    "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
    "userId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "roleIds": [
      "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
    ],
    "acceptedByDisplayName": "string",
    "acceptedById": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "managerNotes": "string",
    "membershipStatus": "member",
    "isSubscribedToAnnouncements": true,
    "isSubscribedToEventAnnouncements": true,
    "visibility": "visible",
    "isRepresenting": false,
    "joinedAt": "2019-08-24T14:15:22Z",
    "bannedAt": "string",
    "has2FA": false,
    "hasJoinedFromPurchase": false,
    "lastPostReadAt": "2019-08-24T14:15:22Z",
    "mRoleIds": [
      "string"
    ],
    "permissions": [
      "*"
    ]
  },
  "roles": [
    {
      "id": "grol_459d3911-f672-44bc-b84d-e54ffe7960fe",
      "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
      "name": "string",
      "description": "string",
      "isSelfAssignable": false,
      "permissions": [
        "*"
      ],
      "isManagementRole": false,
      "requiresTwoFactor": false,
      "requiresPurchase": false,
      "order": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

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

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