# pub.chive.collection.getFollowStatus

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collection.getFollowStatus)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collection.getFollowStatus/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collection.getFollowStatus/examples)

## Definitions

### `pub.chive.collection.getFollowStatus`

**Type**: `query`

Check if a user follows a collection (via network.cosmik.follow records)

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `subject` | `string` | Yes | AT-URI of the collection |
| `followerDid` | `string` | Yes | DID of the potential follower |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `followUri` | `string` | Yes | AT-URI of the follow record, or empty string if not following |

## Raw Schema

```json
{
  "id": "pub.chive.collection.getFollowStatus",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "followUri"
          ],
          "properties": {
            "followUri": {
              "type": "string",
              "description": "AT-URI of the follow record, or empty string if not following"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "followerDid",
          "subject"
        ],
        "properties": {
          "subject": {
            "type": "string",
            "description": "AT-URI of the collection"
          },
          "followerDid": {
            "type": "string",
            "description": "DID of the potential follower"
          }
        }
      },
      "description": "Check if a user follows a collection (via network.cosmik.follow records)"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```