# social.colibri.channel.read

> 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.read)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.channel.read/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.channel.read/examples)

## Definitions

### `social.colibri.channel.read`

**Type**: `record`

A read cursor for a Colibri channel, indicating the last read message by a user.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `$type` | `string` (nsid) | No | The type of the record. |
| `cursor` | `string` (datetime) | Yes | The timestamp the channel was last read at. |
| `channel` | `string` (at-uri) | Yes | The channel this message was sent in. |

## Raw Schema

```json
{
  "id": "social.colibri.channel.read",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "channel",
          "cursor"
        ],
        "properties": {
          "$type": {
            "type": "string",
            "format": "nsid",
            "description": "The type of the record."
          },
          "cursor": {
            "type": "string",
            "format": "datetime",
            "description": "The timestamp the channel was last read at."
          },
          "channel": {
            "type": "string",
            "format": "at-uri",
            "description": "The channel this message was sent in."
          }
        }
      },
      "description": "A read cursor for a Colibri channel, indicating the last read message by a user."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```