4.2 KiB
\UsersApi
All URIs are relative to https://api.vrchat.cloud/api/1
| Method | HTTP request | Description |
|---|---|---|
| get_user | GET /users/{userId} | Get User by ID |
| get_user_by_name | GET /users/{username}/name | Get User by Username |
| search_users | GET /users | Search All Users |
| update_user | PUT /users/{userId} | Update User Info |
get_user
crate::models::User get_user(user_id) Get User by ID
Get public user information about a specific user using their ID.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | String | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_user_by_name
crate::models::User get_user_by_name(username) Get User by Username
Get public user information about a specific user using their name. DEPRECATED: VRChat API no longer return usernames of other users. See issue by Tupper for more information. This endpoint now require Admin Credentials.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| username | String | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
search_users
Veccrate::models::LimitedUser search_users(search, developer_type, n, offset) Search All Users
Search and list any users by text query
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| search | Option<String> | Searches by displayName. Will return empty array if search query is empty or missing. |
||
| developer_type | Option<String> | Active user by developer type, none for normal users and internal for moderators | ||
| n | Option<i32> | The number of objects to return. | [default to 60] | |
| offset | Option<i32> | A zero-based offset from the default object sorting from where search results start. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_user
crate::models::CurrentUser update_user(user_id, update_user_request) Update User Info
Update a users information such as the email and birthday.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | String | [required] | ||
| update_user_request | Option<UpdateUserRequest> |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]