---
title: "network.friend-circle@1 · OpenVibe.Services"
canonical: "https://openvibe.services/docs/contracts/network.friend-circle"
updated: null
---

# network.friend-circle@1 · OpenVibe.Services

HTML: [network.friend-circle@1 · OpenVibe.Services](https://openvibe.services/docs/contracts/network.friend-circle)

# NetworkFriendCircle `network.friend-circle@1`

Generated at 2026-11-17 06:52:56 UTC from [`openvibe-contracts v0.443.0`](https://github.com/OpenVibers/OpenVibe.Contracts/tree/v0.443.0) and [`openvibe-sdk v0.177.0`](https://github.com/OpenVibers/OpenVibe.SDK/tree/v0.177.0).

- Version: 1.0.0
- Owner: network
- Visibility: first-party
- Status: active
- Compatibility: backward
- Schema: [`https://openvibe.network/contracts/network/friend-circle.v1.json`](/docs/contracts/network.friend-circle.json)

network.friend-circle@1 (plan §AB.51; the owner, 11-14: "implement the friend system so it can be used across sites … synced with your network account … SDK and API … send and request … make your own UIs"). GET /api/v1/me/friends on OpenVibe.Network: the person's friends in one read. Adding is one direction; two people are friends when both have added each other. mutual: friends; requests: they added you, you have not added them; asked: you added them, they have not added you. friends: whom you added (both mutual and asked), kept for older readers. Online people first in each list. A block on either side removes the person from every list.

## Fields

| Field | Type | Required | Description | Constraints |
| --- | --- | --- | --- | --- |
| `subject` | string | yes | The person reading. | - `pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$` |
| `friends` | array of object | yes |  | - `maxItems 5000` |
| `friends[].subject` | string | yes |  | - `pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$` |
| `mutual` | array of object | yes |  | - `maxItems 5000`<br>- `items: no other fields` |
| `mutual[].subject` | string | yes |  | - `pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$` |
| `mutual[].username` | string \| null | yes |  | - `maxLength 64` |
| `mutual[].display_name` | string \| null | yes |  | - `maxLength 128` |
| `mutual[].avatar_url` | string \| null |  |  | - `pattern ^https://`<br>- `format uri`<br>- `maxLength 2048` |
| `mutual[].online` | boolean | yes | Seen on an OpenVibe site in the last few minutes (Network's presence). |  |
| `mutual[].site` | string \| null |  | Where they are, when online and they share it. | - `maxLength 80` |
| `mutual[].since` | string \| null |  | When this side of the friendship last changed. | - `maxLength 40` |
| `requests` | array of object | yes |  | - `maxItems 5000`<br>- `items: no other fields` |
| `requests[].subject` | string | yes |  | - `pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$` |
| `requests[].username` | string \| null | yes |  | - `maxLength 64` |
| `requests[].display_name` | string \| null | yes |  | - `maxLength 128` |
| `requests[].avatar_url` | string \| null |  |  | - `pattern ^https://`<br>- `format uri`<br>- `maxLength 2048` |
| `requests[].online` | boolean | yes | Seen on an OpenVibe site in the last few minutes (Network's presence). |  |
| `requests[].site` | string \| null |  | Where they are, when online and they share it. | - `maxLength 80` |
| `requests[].since` | string \| null |  | When this side of the friendship last changed. | - `maxLength 40` |
| `asked` | array of object | yes |  | - `maxItems 5000`<br>- `items: no other fields` |
| `asked[].subject` | string | yes |  | - `pattern ^usr_[0-9A-HJKMNP-TV-Z]{26}$` |
| `asked[].username` | string \| null | yes |  | - `maxLength 64` |
| `asked[].display_name` | string \| null | yes |  | - `maxLength 128` |
| `asked[].avatar_url` | string \| null |  |  | - `pattern ^https://`<br>- `format uri`<br>- `maxLength 2048` |
| `asked[].online` | boolean | yes | Seen on an OpenVibe site in the last few minutes (Network's presence). |  |
| `asked[].site` | string \| null |  | Where they are, when online and they share it. | - `maxLength 80` |
| `asked[].since` | string \| null |  | When this side of the friendship last changed. | - `maxLength 40` |

## Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

 Valid: circle

~~~~
{
  "subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GH",
  "friends": [
    {
      "subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GJ"
    }
  ],
  "mutual": [
    {
      "subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GJ",
      "username": "ada",
      "display_name": "Ada",
      "avatar_url": "https://openvibe.network/avatar/ada?s=80",
      "online": true,
      "site": "openvibe.live",
      "since": "2026-11-14T08:00:00.000Z"
    }
  ],
  "requests": [],
  "asked": []
}
~~~~

Rejected: no-mutual

~~~~
{
  "subject": "usr_01K9R2V6M8Q4T0B7C3D5E9F2GH",
  "friends": [],
  "requests": [],
  "asked": []
}
~~~~

## Validate

~~~~
const contracts = require('openvibe-contracts');
contracts.validate('network.friend-circle@1', value);   // { valid, errors: [{ path, message }] }
~~~~
