# town.delve.contact.getMatches

> Published by [delve.town](https://lexicon.garden/identity/did:plc:qzqct2rrq4u2gmy5g3mjxske)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.contact.getMatches)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.contact.getMatches/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qzqct2rrq4u2gmy5g3mjxske/town.delve.contact.getMatches/examples)

## Definitions

### `town.delve.contact.getMatches`

**Type**: `query`

Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.

#### 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 |  |

#### Errors

- **InvalidDid**
- **InvalidLimit**
- **InvalidCursor**
- **InternalError**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication.",
      "errors": [
        {
          "name": "InvalidDid"
        },
        {
          "name": "InvalidLimit"
        },
        {
          "name": "InvalidCursor"
        },
        {
          "name": "InternalError"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "type": "string"
            },
            "matches": {
              "items": {
                "ref": "town.delve.actor.defs#profileView",
                "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"
    }
  },
  "id": "town.delve.contact.getMatches",
  "lexicon": 1
}
```