# app.lovesky.match.getMatches

> Published by [toddlambert.com](https://lexicon.garden/identity/did:plc:r5pj64joaywqnvk2obembpt7)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:r5pj64joaywqnvk2obembpt7/app.lovesky.match.getMatches)
- [Documentation](https://lexicon.garden/lexicon/did:plc:r5pj64joaywqnvk2obembpt7/app.lovesky.match.getMatches/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:r5pj64joaywqnvk2obembpt7/app.lovesky.match.getMatches/examples)

## Definitions

### `app.lovesky.match.getMatches`

**Type**: `query`

The caller's mutual matches, newest first.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `limit` | `integer` | No |  |

#### Output

**Encoding**: `application/json`

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

### `app.lovesky.match.getMatches#matchView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `convoId` | `string` | Yes |  |
| `lastMessageAt` | `string` (datetime) | No |  |
| `matchedAt` | `string` (datetime) | Yes |  |
| `profile` | `ref` → `app.lovesky.actor.defs#profileView` | Yes |  |
| `unreadCount` | `integer` | No |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The caller's mutual matches, newest first.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "matches": {
              "items": {
                "ref": "#matchView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "matches"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "type": "string"
          },
          "limit": {
            "default": 50,
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "matchView": {
      "properties": {
        "convoId": {
          "type": "string"
        },
        "lastMessageAt": {
          "format": "datetime",
          "type": "string"
        },
        "matchedAt": {
          "format": "datetime",
          "type": "string"
        },
        "profile": {
          "ref": "app.lovesky.actor.defs#profileView",
          "type": "ref"
        },
        "unreadCount": {
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "profile",
        "convoId",
        "matchedAt"
      ],
      "type": "object"
    }
  },
  "id": "app.lovesky.match.getMatches",
  "lexicon": 1
}
```