# app.zeens.getConvos

> Published by [zeens.app](https://lexicon.garden/identity/did:plc:pwpuqwge6g7xrjmfbw73uycw)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getConvos)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getConvos/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pwpuqwge6g7xrjmfbw73uycw/app.zeens.getConvos/examples)

## Definitions

### `app.zeens.getConvos`

**Type**: `query`

Return a viewer's conversation list (newest activity first), paginated. No message preview is returned. 'state' selects the inbox or the requests bucket.

#### Parameters

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

#### Output

**Encoding**: `application/json`

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

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Return a viewer's conversation list (newest activity first), paginated. No message preview is returned. 'state' selects the inbox or the requests bucket.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "allow": {
              "enum": [
                "off",
                "mutuals",
                "everyone"
              ],
              "type": "string"
            },
            "convos": {
              "items": {
                "properties": {
                  "convoId": {
                    "type": "string"
                  },
                  "latestAt": {
                    "type": "string"
                  },
                  "peerDid": {
                    "format": "did",
                    "type": "string"
                  },
                  "unread": {
                    "minimum": 0,
                    "type": "integer"
                  }
                },
                "required": [
                  "convoId",
                  "peerDid",
                  "latestAt",
                  "unread"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "cursor": {
              "type": "string"
            }
          },
          "required": [
            "convos"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 36,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "state": {
            "default": "inbox",
            "enum": [
              "inbox",
              "requests"
            ],
            "type": "string"
          },
          "viewer": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "viewer"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "app.zeens.getConvos",
  "lexicon": 1
}
```