# com.getorbyt.graph.getNetworkFriends

> Published by [getorbyt.com](https://lexicon.garden/identity/did:plc:2xrqztnmzlckb3xfuuukupso)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.graph.getNetworkFriends)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.graph.getNetworkFriends/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.graph.getNetworkFriends/examples)

## Definitions

### `com.getorbyt.graph.getNetworkFriends`

**Type**: `query`

Orbyt accounts the viewer follows on the connected network, as of their last follow sync: the find-friends list. Requires service auth.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `filter` | `string` | No | `notFollowed` leaves out accounts the viewer already follows on Orbyt or has unfollowed after an import, which is the set an import would follow. |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `friends` | `array` | Yes |  |
| `syncedAt` | `string` (datetime) | No | When the viewer's network follows were last read. Absent before the first sync. |

#### Errors

- **AuthenticationRequired**
- **InvalidCursor**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Orbyt accounts the viewer follows on the connected network, as of their last follow sync: the find-friends list. Requires service auth.",
      "errors": [
        {
          "name": "AuthenticationRequired"
        },
        {
          "name": "InvalidCursor"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "friends": {
              "items": {
                "ref": "com.getorbyt.actor.defs#profileView",
                "type": "ref"
              },
              "maxLength": 100,
              "type": "array"
            },
            "syncedAt": {
              "description": "When the viewer's network follows were last read. Absent before the first sync.",
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "friends"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "filter": {
            "default": "all",
            "description": "`notFollowed` leaves out accounts the viewer already follows on Orbyt or has unfollowed after an import, which is the set an import would follow.",
            "knownValues": [
              "all",
              "notFollowed"
            ],
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "com.getorbyt.graph.getNetworkFriends",
  "lexicon": 1
}
```