Backfill in-progress. Some lexicons and records may be missing or incomplete.

app.bsky.contact.getMatches

bsky-lexicons.bsky.social

Documentation

main query

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

Parameters

cursor string Optional

No description provided.

limit integer Optional

No description provided.

Output

Encodingapplication/json
cursor string Optional

No description provided.

matches array Required

No description provided.

Errors

InvalidDid
InvalidLimit
InvalidCursor
InternalError
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
View raw schema
{
  "type": "query",
  "errors": [
    {
      "name": "InvalidDid"
    },
    {
      "name": "InvalidLimit"
    },
    {
      "name": "InvalidCursor"
    },
    {
      "name": "InternalError"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "matches"
      ],
      "properties": {
        "cursor": {
          "type": "string"
        },
        "matches": {
          "type": "array",
          "items": {
            "ref": "app.bsky.actor.defs#profileView",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1
      },
      "cursor": {
        "type": "string"
      }
    }
  },
  "description": "Returns the matched contacts (contacts that were mutually imported). Excludes dismissed matches. Requires authentication."
}

Lexicon Garden

@