GroupsApi.md

vrchat_dart_generated.api.GroupsApi

Load the API package

import 'package:vrchat_dart_generated/api.dart';

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
addGroupGalleryImage	POST /groups/{groupId}/galleries/{groupGalleryId}/images	Add Group Gallery Image
addGroupMemberRole	PUT /groups/{groupId}/members/{userId}/roles/{groupRoleId}	Add Role to GroupMember
addGroupPost	POST /groups/{groupId}/posts	Create a post in a Group
banGroupMember	POST /groups/{groupId}/bans	Ban Group Member
cancelGroupRequest	DELETE /groups/{groupId}/requests	Cancel Group Join Request
createGroup	POST /groups	Create Group
createGroupAnnouncement	POST /groups/{groupId}/announcement	Create Group Announcement
createGroupGallery	POST /groups/{groupId}/galleries	Create Group Gallery
createGroupInvite	POST /groups/{groupId}/invites	Invite User to Group
createGroupRole	POST /groups/{groupId}/roles	Create GroupRole
deleteGroup	DELETE /groups/{groupId}	Delete Group
deleteGroupAnnouncement	DELETE /groups/{groupId}/announcement	Delete Group Announcement
deleteGroupGallery	DELETE /groups/{groupId}/galleries/{groupGalleryId}	Delete Group Gallery
deleteGroupGalleryImage	DELETE /groups/{groupId}/galleries/{groupGalleryId}/images/{groupGalleryImageId}	Delete Group Gallery Image
deleteGroupInvite	DELETE /groups/{groupId}/invites/{userId}	Delete User Invite
deleteGroupPost	DELETE /groups/{groupId}/posts/{notificationId}	Delete a Group post
deleteGroupRole	DELETE /groups/{groupId}/roles/{groupRoleId}	Delete Group Role
getGroup	GET /groups/{groupId}	Get Group by ID
getGroupAnnouncements	GET /groups/{groupId}/announcement	Get Group Announcement
getGroupAuditLogs	GET /groups/{groupId}/auditLogs	Get Group Audit Logs
getGroupBans	GET /groups/{groupId}/bans	Get Group Bans
getGroupGalleryImages	GET /groups/{groupId}/galleries/{groupGalleryId}	Get Group Gallery Images
getGroupInstances	GET /groups/{groupId}/instances	Get Group Instances
getGroupInvites	GET /groups/{groupId}/invites	Get Group Invites Sent
getGroupMember	GET /groups/{groupId}/members/{userId}	Get Group Member
getGroupMembers	GET /groups/{groupId}/members	List Group Members
getGroupPermissions	GET /groups/{groupId}/permissions	List Group Permissions
getGroupPost	GET /groups/{groupId}/posts	Get posts from a Group
getGroupRequests	GET /groups/{groupId}/requests	Get Group Join Requests
getGroupRoles	GET /groups/{groupId}/roles	Get Group Roles
joinGroup	POST /groups/{groupId}/join	Join Group
kickGroupMember	DELETE /groups/{groupId}/members/{userId}	Kick Group Member
leaveGroup	POST /groups/{groupId}/leave	Leave Group
removeGroupMemberRole	DELETE /groups/{groupId}/members/{userId}/roles/{groupRoleId}	Remove Role from GroupMember
respondGroupJoinRequest	PUT /groups/{groupId}/requests/{userId}	Respond Group Join request
searchGroups	GET /groups	Search Group
unbanGroupMember	DELETE /groups/{groupId}/bans/{userId}	Unban Group Member
updateGroup	PUT /groups/{groupId}	Update Group
updateGroupGallery	PUT /groups/{groupId}/galleries/{groupGalleryId}	Update Group Gallery
updateGroupMember	PUT /groups/{groupId}/members/{userId}	Update Group Member
updateGroupPost	PUT /groups/{groupId}/posts/{notificationId}	Edits a Group post
updateGroupRole	PUT /groups/{groupId}/roles/{groupRoleId}	Update Group Role

addGroupGalleryImage

GroupGalleryImage addGroupGalleryImage(groupId, groupGalleryId, addGroupGalleryImageRequest)

Add Group Gallery Image

Adds an image to a Group gallery.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupGalleryId = ggal_00000000-0000-0000-0000-000000000000; // String | Must be a valid group gallery ID.
final AddGroupGalleryImageRequest addGroupGalleryImageRequest = ; // AddGroupGalleryImageRequest | 

try {
    final response = api.addGroupGalleryImage(groupId, groupGalleryId, addGroupGalleryImageRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->addGroupGalleryImage: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupGalleryId	String	Must be a valid group gallery ID.
addGroupGalleryImageRequest	AddGroupGalleryImageRequest

Return type

GroupGalleryImage

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addGroupMemberRole

List addGroupMemberRole(groupId, userId, groupRoleId)

Add Role to GroupMember

Adds a Role to a Group Member

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.
final String groupRoleId = grol_00000000-0000-0000-0000-000000000000; // String | Must be a valid group role ID.

try {
    final response = api.addGroupMemberRole(groupId, userId, groupRoleId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->addGroupMemberRole: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.
groupRoleId	String	Must be a valid group role ID.

Return type

List<String>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addGroupPost

GroupPost addGroupPost(groupId, createGroupPostRequest)

Create a post in a Group

Create a post in a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final CreateGroupPostRequest createGroupPostRequest = ; // CreateGroupPostRequest | 

try {
    final response = api.addGroupPost(groupId, createGroupPostRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->addGroupPost: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
createGroupPostRequest	CreateGroupPostRequest

Return type

GroupPost

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

banGroupMember

GroupMember banGroupMember(groupId, banGroupMemberRequest)

Ban Group Member

Bans a user from a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final BanGroupMemberRequest banGroupMemberRequest = ; // BanGroupMemberRequest | 

try {
    final response = api.banGroupMember(groupId, banGroupMemberRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->banGroupMember: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
banGroupMemberRequest	BanGroupMemberRequest

Return type

GroupMember

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancelGroupRequest

cancelGroupRequest(groupId)

Cancel Group Join Request

Cancels a request sent to join the group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    api.cancelGroupRequest(groupId);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->cancelGroupRequest: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

void (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGroup

Group createGroup(createGroupRequest)

Create Group

Creates a Group and returns a Group object. Requires VRC+ Subscription.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final CreateGroupRequest createGroupRequest = ; // CreateGroupRequest | 

try {
    final response = api.createGroup(createGroupRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->createGroup: $e\n');
}

Parameters

Name	Type	Description	Notes
createGroupRequest	CreateGroupRequest

Return type

Group

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGroupAnnouncement

GroupAnnouncement createGroupAnnouncement(groupId, createGroupAnnouncementRequest)

Create Group Announcement

Creates an Announcement for a Group. Warning: This will also remove all announcements. To make proper announcements, use the posts endpoint instead

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final CreateGroupAnnouncementRequest createGroupAnnouncementRequest = ; // CreateGroupAnnouncementRequest | 

try {
    final response = api.createGroupAnnouncement(groupId, createGroupAnnouncementRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->createGroupAnnouncement: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
createGroupAnnouncementRequest	CreateGroupAnnouncementRequest

Return type

GroupAnnouncement

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGroupGallery

GroupGallery createGroupGallery(groupId, createGroupGalleryRequest)

Create Group Gallery

Creates a gallery for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final CreateGroupGalleryRequest createGroupGalleryRequest = ; // CreateGroupGalleryRequest | 

try {
    final response = api.createGroupGallery(groupId, createGroupGalleryRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->createGroupGallery: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
createGroupGalleryRequest	CreateGroupGalleryRequest

Return type

GroupGallery

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGroupInvite

createGroupInvite(groupId, createGroupInviteRequest)

Invite User to Group

Sends an invite to a user to join the group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final CreateGroupInviteRequest createGroupInviteRequest = ; // CreateGroupInviteRequest | 

try {
    api.createGroupInvite(groupId, createGroupInviteRequest);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->createGroupInvite: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
createGroupInviteRequest	CreateGroupInviteRequest

Return type

void (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createGroupRole

GroupRole createGroupRole(groupId, createGroupRoleRequest)

Create GroupRole

Create a Group role.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final CreateGroupRoleRequest createGroupRoleRequest = ; // CreateGroupRoleRequest | 

try {
    final response = api.createGroupRole(groupId, createGroupRoleRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->createGroupRole: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
createGroupRoleRequest	CreateGroupRoleRequest

Return type

GroupRole

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroup

Success deleteGroup(groupId)

Delete Group

Deletes a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.deleteGroup(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroup: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroupAnnouncement

Success deleteGroupAnnouncement(groupId)

Delete Group Announcement

Deletes the announcement for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.deleteGroupAnnouncement(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroupAnnouncement: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroupGallery

Success deleteGroupGallery(groupId, groupGalleryId)

Delete Group Gallery

Deletes a gallery for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupGalleryId = ggal_00000000-0000-0000-0000-000000000000; // String | Must be a valid group gallery ID.

try {
    final response = api.deleteGroupGallery(groupId, groupGalleryId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroupGallery: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupGalleryId	String	Must be a valid group gallery ID.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroupGalleryImage

Success deleteGroupGalleryImage(groupId, groupGalleryId, groupGalleryImageId)

Delete Group Gallery Image

Deletes an image from a Group gallery.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupGalleryId = ggal_00000000-0000-0000-0000-000000000000; // String | Must be a valid group gallery ID.
final String groupGalleryImageId = ggim_00000000-0000-0000-0000-000000000000; // String | Must be a valid group gallery image ID.

try {
    final response = api.deleteGroupGalleryImage(groupId, groupGalleryId, groupGalleryImageId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroupGalleryImage: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupGalleryId	String	Must be a valid group gallery ID.
groupGalleryImageId	String	Must be a valid group gallery image ID.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroupInvite

deleteGroupInvite(groupId, userId)

Delete User Invite

Deletes an Group invite sent to a User

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.

try {
    api.deleteGroupInvite(groupId, userId);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroupInvite: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.

Return type

void (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroupPost

Success deleteGroupPost(groupId, notificationId)

Delete a Group post

Delete a Group post

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String notificationId = notificationId_example; // String | Must be a valid notification ID.

try {
    final response = api.deleteGroupPost(groupId, notificationId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroupPost: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
notificationId	String	Must be a valid notification ID.

Return type

Success

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteGroupRole

List deleteGroupRole(groupId, groupRoleId)

Delete Group Role

Deletes a Group Role by ID and returns the remaining roles.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupRoleId = grol_00000000-0000-0000-0000-000000000000; // String | Must be a valid group role ID.

try {
    final response = api.deleteGroupRole(groupId, groupRoleId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->deleteGroupRole: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupRoleId	String	Must be a valid group role ID.

Return type

List<GroupRole>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroup

Group getGroup(groupId, includeRoles)

Get Group by ID

Returns a single Group by ID.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final bool includeRoles = true; // bool | Include roles for the Group object. Defaults to false.

try {
    final response = api.getGroup(groupId, includeRoles);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroup: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
includeRoles	bool	Include roles for the Group object. Defaults to false.	[optional]

Return type

Group

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupAnnouncements

GroupAnnouncement getGroupAnnouncements(groupId)

Get Group Announcement

Returns the announcement for a Group. If no announcement has been made, then it returns empty object. If an announcement exists, then it will always return all fields except imageId and imageUrl which may be null.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.getGroupAnnouncements(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupAnnouncements: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

GroupAnnouncement

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupAuditLogs

PaginatedGroupAuditLogEntryList getGroupAuditLogs(groupId, n, offset, startDate, endDate)

Get Group Audit Logs

Returns a list of audit logs for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.
final DateTime startDate = 2013-10-20T19:20:30+01:00; // DateTime | The start date of the search range.
final DateTime endDate = 2013-10-20T19:20:30+01:00; // DateTime | The end date of the search range.

try {
    final response = api.getGroupAuditLogs(groupId, n, offset, startDate, endDate);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupAuditLogs: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]
startDate	DateTime	The start date of the search range.	[optional]
endDate	DateTime	The end date of the search range.	[optional]

Return type

PaginatedGroupAuditLogEntryList

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupBans

List getGroupBans(groupId, n, offset)

Get Group Bans

Returns a list of banned users for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.

try {
    final response = api.getGroupBans(groupId, n, offset);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupBans: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]

Return type

List<GroupMember>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupGalleryImages

List getGroupGalleryImages(groupId, groupGalleryId, n, offset, approved)

Get Group Gallery Images

Returns a list of images for a Group gallery.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupGalleryId = ggal_00000000-0000-0000-0000-000000000000; // String | Must be a valid group gallery ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.
final bool approved = true; // bool | If specified, only returns images that have been approved or not approved.

try {
    final response = api.getGroupGalleryImages(groupId, groupGalleryId, n, offset, approved);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupGalleryImages: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupGalleryId	String	Must be a valid group gallery ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]
approved	bool	If specified, only returns images that have been approved or not approved.	[optional]

Return type

List<GroupGalleryImage>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupInstances

List getGroupInstances(groupId)

Get Group Instances

Returns a list of group instances

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.getGroupInstances(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupInstances: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

List<GroupInstance>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupInvites

List getGroupInvites(groupId, n, offset)

Get Group Invites Sent

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

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.

try {
    final response = api.getGroupInvites(groupId, n, offset);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupInvites: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]

Return type

List<GroupMember>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupMember

GroupLimitedMember getGroupMember(groupId, userId)

Get Group Member

Returns a LimitedGroup Member.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.

try {
    final response = api.getGroupMember(groupId, userId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupMember: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.

Return type

GroupLimitedMember

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupMembers

List getGroupMembers(groupId, n, offset, sort, roleId)

List Group Members

Returns a List of all other Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the myMember field of the Group object.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.
final GroupSearchSort sort = ; // GroupSearchSort | The sort order of Group Member results
final String roleId = roleId_example; // String | Only returns members with a specific groupRoleId

try {
    final response = api.getGroupMembers(groupId, n, offset, sort, roleId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupMembers: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]
sort	GroupSearchSort	The sort order of Group Member results	[optional]
roleId	String	Only returns members with a specific groupRoleId	[optional]

Return type

List<GroupMember>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupPermissions

List getGroupPermissions(groupId)

List Group Permissions

Returns a List of all possible/available permissions for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.getGroupPermissions(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupPermissions: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

List<GroupPermission>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupPost

GroupPost getGroupPost(groupId, n, offset, publicOnly)

Get posts from a Group

Get posts from a Group

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.
final bool publicOnly = true; // bool | See public posts only.

try {
    final response = api.getGroupPost(groupId, n, offset, publicOnly);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupPost: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]
publicOnly	bool	See public posts only.	[optional]

Return type

GroupPost

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupRequests

List getGroupRequests(groupId, n, offset, blocked)

Get Group Join Requests

Returns a list of members that have requested to join the Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final int n = 56; // int | The number of objects to return.
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.
final bool blocked = true; // bool | See blocked join requests

try {
    final response = api.getGroupRequests(groupId, n, offset, blocked);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupRequests: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
n	int	The number of objects to return.	[optional] [default to 60]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]
blocked	bool	See blocked join requests	[optional]

Return type

List<GroupMember>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupRoles

List getGroupRoles(groupId)

Get Group Roles

Returns a Group Role by ID.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.getGroupRoles(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->getGroupRoles: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

List<GroupRole>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

joinGroup

GroupMember joinGroup(groupId)

Join Group

Join a Group by ID and returns the member object.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    final response = api.joinGroup(groupId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->joinGroup: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

GroupMember

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

kickGroupMember

kickGroupMember(groupId, userId)

Kick Group Member

Kicks a Group Member from the Group. The current user must have the "Remove Group Members" permission.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.

try {
    api.kickGroupMember(groupId, userId);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->kickGroupMember: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.

Return type

void (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

leaveGroup

leaveGroup(groupId)

Leave Group

Leave a group by ID.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.

try {
    api.leaveGroup(groupId);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->leaveGroup: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.

Return type

void (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeGroupMemberRole

List removeGroupMemberRole(groupId, userId, groupRoleId)

Remove Role from GroupMember

Removes a Role from a Group Member

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.
final String groupRoleId = grol_00000000-0000-0000-0000-000000000000; // String | Must be a valid group role ID.

try {
    final response = api.removeGroupMemberRole(groupId, userId, groupRoleId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->removeGroupMemberRole: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.
groupRoleId	String	Must be a valid group role ID.

Return type

List<String>

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

respondGroupJoinRequest

respondGroupJoinRequest(groupId, userId, respondGroupJoinRequest)

Respond Group Join request

Responds to a Group Join Request with Accept/Deny

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.
final RespondGroupJoinRequest respondGroupJoinRequest = ; // RespondGroupJoinRequest | 

try {
    api.respondGroupJoinRequest(groupId, userId, respondGroupJoinRequest);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->respondGroupJoinRequest: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.
respondGroupJoinRequest	RespondGroupJoinRequest

Return type

void (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchGroups

List searchGroups(query, offset, n)

Search Group

Searches Groups by name or shortCode

Example

import 'package:vrchat_dart_generated/api.dart';

final api = VrchatDartGenerated().getGroupsApi();
final String query = query_example; // String | Query to search for, can be either Group Name or Group shortCode
final int offset = 56; // int | A zero-based offset from the default object sorting from where search results start.
final int n = 56; // int | The number of objects to return.

try {
    final response = api.searchGroups(query, offset, n);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->searchGroups: $e\n');
}

Parameters

Name	Type	Description	Notes
query	String	Query to search for, can be either Group Name or Group shortCode	[optional]
offset	int	A zero-based offset from the default object sorting from where search results start.	[optional]
n	int	The number of objects to return.	[optional] [default to 60]

Return type

List<LimitedGroup>

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unbanGroupMember

GroupMember unbanGroupMember(groupId, userId)

Unban Group Member

Unbans a user from a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.

try {
    final response = api.unbanGroupMember(groupId, userId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->unbanGroupMember: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.

Return type

GroupMember

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroup

Group updateGroup(groupId, updateGroupRequest)

Update Group

Updates a Group and returns it.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final UpdateGroupRequest updateGroupRequest = ; // UpdateGroupRequest | 

try {
    final response = api.updateGroup(groupId, updateGroupRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->updateGroup: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
updateGroupRequest	UpdateGroupRequest		[optional]

Return type

Group

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroupGallery

GroupGallery updateGroupGallery(groupId, groupGalleryId, updateGroupGalleryRequest)

Update Group Gallery

Updates a gallery for a Group.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupGalleryId = ggal_00000000-0000-0000-0000-000000000000; // String | Must be a valid group gallery ID.
final UpdateGroupGalleryRequest updateGroupGalleryRequest = ; // UpdateGroupGalleryRequest | 

try {
    final response = api.updateGroupGallery(groupId, groupGalleryId, updateGroupGalleryRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->updateGroupGallery: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupGalleryId	String	Must be a valid group gallery ID.
updateGroupGalleryRequest	UpdateGroupGalleryRequest		[optional]

Return type

GroupGallery

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroupMember

GroupLimitedMember updateGroupMember(groupId, userId, updateGroupMemberRequest)

Update Group Member

Updates a Group Member

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String userId = userId_example; // String | Must be a valid user ID.
final UpdateGroupMemberRequest updateGroupMemberRequest = ; // UpdateGroupMemberRequest | 

try {
    final response = api.updateGroupMember(groupId, userId, updateGroupMemberRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->updateGroupMember: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
userId	String	Must be a valid user ID.
updateGroupMemberRequest	UpdateGroupMemberRequest		[optional]

Return type

GroupLimitedMember

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroupPost

GroupPost updateGroupPost(groupId, notificationId, createGroupPostRequest)

Edits a Group post

Edits a Group post

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String notificationId = notificationId_example; // String | Must be a valid notification ID.
final CreateGroupPostRequest createGroupPostRequest = ; // CreateGroupPostRequest | 

try {
    final response = api.updateGroupPost(groupId, notificationId, createGroupPostRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->updateGroupPost: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
notificationId	String	Must be a valid notification ID.
createGroupPostRequest	CreateGroupPostRequest

Return type

GroupPost

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateGroupRole

List updateGroupRole(groupId, groupRoleId, updateGroupRoleRequest)

Update Group Role

Updates a group role by ID.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getGroupsApi();
final String groupId = grp_00000000-0000-0000-0000-000000000000; // String | Must be a valid group ID.
final String groupRoleId = grol_00000000-0000-0000-0000-000000000000; // String | Must be a valid group role ID.
final UpdateGroupRoleRequest updateGroupRoleRequest = ; // UpdateGroupRoleRequest | 

try {
    final response = api.updateGroupRole(groupId, groupRoleId, updateGroupRoleRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling GroupsApi->updateGroupRole: $e\n');
}

Parameters

Name	Type	Description	Notes
groupId	String	Must be a valid group ID.
groupRoleId	String	Must be a valid group role ID.
updateGroupRoleRequest	UpdateGroupRoleRequest		[optional]

Return type

List<GroupRole>

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]