v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Search Group

Searches Groups by name or shortCode

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

GET
/groups

Query Parameters

query?string

Query to search for, can be either Group Name or Group shortCode

offset?integer

A zero-based offset from the default object sorting from where search results start.

Range0 <= value
n?integer

The number of objects to return.

Default60
Range1 <= value <= 100

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/groups?query=string&offset=0&n=60"
[
  {
    "id": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
    "name": "string",
    "shortCode": "ABC123",
    "discriminator": "1234",
    "description": "string",
    "iconUrl": "string",
    "bannerUrl": "string",
    "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "rules": "string",
    "iconId": "string",
    "bannerId": "string",
    "memberCount": 0,
    "tags": [
      "string"
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "membershipStatus": "member",
    "isSearchable": true,
    "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"
      }
    ]
  }
]

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