v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Get Group Invites Sent

Returns a list of members that have been invited to the Group.

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

GET
/groups/{groupId}/invites

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

groupIdstring

Must be a valid group ID.

Query Parameters

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

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/groups/grp_00000000-0000-0000-0000-000000000000/invites?n=60&offset=0"
[
  {
    "acceptedByDisplayName": "string",
    "acceptedById": "string",
    "id": "gmem_95cdb3b4-4643-4eb6-bdab-46a4e1e5ce37",
    "groupId": "grp_71a7ff59-112c-4e78-a990-c7cc650776e5",
    "userId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "isRepresenting": true,
    "user": {
      "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
      "displayName": "string",
      "thumbnailUrl": "string",
      "iconUrl": "string",
      "profilePicOverride": "string",
      "currentAvatarThumbnailImageUrl": "string",
      "currentAvatarTags": [
        "string"
      ]
    },
    "roleIds": [
      "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
    ],
    "mRoleIds": [
      "grol_459d3911-f672-44bc-b84d-e54ffe7960fe"
    ],
    "joinedAt": "2019-08-24T14:15:22Z",
    "membershipStatus": "member",
    "visibility": "visible",
    "isSubscribedToAnnouncements": false,
    "isSubscribedToEventAnnouncements": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "bannedAt": "2019-08-24T14:15:22Z",
    "managerNotes": "string",
    "lastPostReadAt": "2019-08-24T14:15:22Z",
    "hasJoinedFromPurchase": true
  }
]

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

{
  "error": {
    "message": "You're not a member.",
    "status_code": 403
  }
}

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