v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Search for calendar events

Get a list of calendar events by search terms

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

GET
/calendar/search

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

searchTermstring

Search term for calendar events.

utcOffset?integer

The offset from UTC in hours of the client or authenticated user.

Range-12 <= value <= 12
n?integer

The number of objects to return.

Default60
Range1 <= value <= 100
offset?integer

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

Range0 <= value

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/calendar/search?searchTerm=game+night&utcOffset=-12&n=60&offset=0"
{
  "results": [
    {
      "accessType": "group",
      "category": "performance",
      "closeInstanceAfterEndMinutes": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "deletedAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "endsAt": "2019-08-24T14:15:22Z",
      "featured": true,
      "guestEarlyJoinMinutes": 0,
      "hostEarlyJoinMinutes": 0,
      "id": "cal_6b182f0c-61ef-4bdf-97fe-94f63bcba27b",
      "imageId": "file_ce35d830-e20a-4df0-a6d4-5aaef4508044",
      "imageUrl": "string",
      "interestedUserCount": 0,
      "isDraft": true,
      "languages": [
        "string"
      ],
      "ownerId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
      "platforms": [
        "string"
      ],
      "roleIds": [
        "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
      ],
      "startsAt": "2019-08-24T14:15:22Z",
      "tags": [
        "string"
      ],
      "title": "string",
      "type": "event",
      "updatedAt": "2019-08-24T14:15:22Z",
      "usesInstanceOverflow": true,
      "userInterest": {
        "createdAt": "2019-08-24T14:15:22Z",
        "isFollowing": true,
        "updatedAt": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "totalCount": 0,
  "hasNext": true
}

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