# pub.chive.subscription.list

> Published by [lexicons.governance.chive.pub](https://lexicon.garden/identity/did:plc:egjghlwgts2hlcer2txilxeh)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.subscription.list)
- [Documentation](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.subscription.list/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:egjghlwgts2hlcer2txilxeh/pub.chive.subscription.list/examples)

## Definitions

### `pub.chive.subscription.list`

**Type**: `query`

The authors a reader subscribes to.

#### Parameters

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

#### Output

**Encoding**: `application/json`

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

### `pub.chive.subscription.list#subscriptionView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | No |  |
| `displayName` | `string` | No |  |
| `handle` | `string` | No |  |
| `publicationDid` | `string` (did) | Yes | The author subscribed to. |
| `publicationUri` | `string` (at-uri) | Yes |  |
| `uri` | `string` (at-uri) | Yes | The subscription record, in the reader's repository. Needed to withdraw it. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The authors a reader subscribes to.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "subscriptions": {
              "items": {
                "ref": "#subscriptionView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "subscriptions"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "subscriberDid": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "subscriberDid"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "subscriptionView": {
      "properties": {
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "displayName": {
          "maxLength": 512,
          "type": "string"
        },
        "handle": {
          "maxLength": 512,
          "type": "string"
        },
        "publicationDid": {
          "description": "The author subscribed to.",
          "format": "did",
          "type": "string"
        },
        "publicationUri": {
          "format": "at-uri",
          "type": "string"
        },
        "uri": {
          "description": "The subscription record, in the reader's repository. Needed to withdraw it.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "publicationUri",
        "publicationDid"
      ],
      "type": "object"
    }
  },
  "id": "pub.chive.subscription.list",
  "lexicon": 1,
  "revision": 1
}
```