# social.colibri.channel.getReadCursor

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.channel.getReadCursor)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.channel.getReadCursor/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.channel.getReadCursor/examples)

## Definitions

### `social.colibri.channel.getReadCursor`

**Type**: `query`

Returns the authenticated user's read cursor for a channel.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `channel` | `string` (at-uri) | Yes |  |

#### Output

**Encoding**: `application/json`

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.
- **InvalidRequest**: A parameter or body field was missing or malformed.
- **NotFound**: The referenced record does not exist.

## Raw Schema

```json
{
  "id": "social.colibri.channel.getReadCursor",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        },
        {
          "name": "InvalidRequest",
          "description": "A parameter or body field was missing or malformed."
        },
        {
          "name": "NotFound",
          "description": "The referenced record does not exist."
        }
      ],
      "output": {
        "schema": {
          "ref": "lex:social.colibri.channel.defs#readCursor",
          "type": "ref"
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "channel"
        ],
        "properties": {
          "channel": {
            "type": "string",
            "format": "at-uri"
          }
        }
      },
      "description": "Returns the authenticated user's read cursor for a channel."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```