v6 documentation is incomplete, want to contribute?

List Friends

List information about friends.

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

GET
/auth/user/friends
auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

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
offline?boolean

Returns only offline users if true, returns only online and active users if false

Response Body

curl -X GET "https://api.vrchat.cloud/api/1/auth/user/friends?n=60&offline=true"
fetch("https://api.vrchat.cloud/api/1/auth/user/friends?n=60&offline=true")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.vrchat.cloud/api/1/auth/user/friends?n=60&offline=true"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.vrchat.cloud/api/1/auth/user/friends?n=60&offline=true"

response = requests.request("GET", url)

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://api.vrchat.cloud/api/1/auth/user/friends?n=60&offline=true"))
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var response = await client.GetAsync("https://api.vrchat.cloud/api/1/auth/user/friends?n=60&offline=true");
var responseBody = await response.Content.ReadAsStringAsync();
[
  {
    "bio": "string",
    "bioLinks": [
      "string"
    ],
    "currentAvatarImageUrl": "https://api.vrchat.cloud/api/1/file/file_ae46d521-7281-4b38-b365-804b32a1d6a7/1/file",
    "currentAvatarThumbnailImageUrl": "https://api.vrchat.cloud/api/1/image/file_aae83ed9-d42d-4d72-9f4b-9f1e41ed17e1/1/256",
    "currentAvatarTags": [
      "string"
    ],
    "developerType": "none",
    "displayName": "string",
    "friendKey": "string",
    "id": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "isFriend": true,
    "imageUrl": "string",
    "last_platform": "standalonewindows",
    "location": "string",
    "last_login": "2019-08-24T14:15:22Z",
    "last_activity": "2019-08-24T14:15:22Z",
    "last_mobile": "2019-08-24T14:15:22Z",
    "platform": "string",
    "profilePicOverride": "string",
    "profilePicOverrideThumbnail": "string",
    "status": "active",
    "statusDescription": "string",
    "tags": [
      "string"
    ],
    "userIcon": "string"
  }
]

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