# org.duckdns.uan1.graph.listFriends

> Published by [atclip.bsky.social](https://lexicon.garden/identity/did:plc:2cs7nlndz3ampan46i74d5gn)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2cs7nlndz3ampan46i74d5gn/org.duckdns.uan1.graph.listFriends)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2cs7nlndz3ampan46i74d5gn/org.duckdns.uan1.graph.listFriends/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2cs7nlndz3ampan46i74d5gn/org.duckdns.uan1.graph.listFriends/examples)

## Definitions

### `org.duckdns.uan1.graph.listFriends#friend`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `displayName` | `string` | No |  |
| `handle` | `string` (handle) | No |  |

### `org.duckdns.uan1.graph.listFriends`

**Type**: `query`

Friends of an actor that the caller (service auth) may see.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (did) | Yes |  |
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `friends` | `array` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "friend": {
      "properties": {
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        }
      },
      "required": [
        "did"
      ],
      "type": "object"
    },
    "main": {
      "description": "Friends of an actor that the caller (service auth) may see.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "friends": {
              "items": {
                "ref": "#friend",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "friends"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "actor": {
            "format": "did",
            "type": "string"
          },
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "actor"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "org.duckdns.uan1.graph.listFriends",
  "lexicon": 1
}
```