# social.colibri.beta.bridge.getPairing

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

## Definitions

### `social.colibri.beta.bridge.getPairing`

**Type**: `query`

Describes a pending pairing code so an admin can see which bridge they are about to connect.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `code` | `string` | Yes | The pairing code. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `pairing` | `ref` → `social.colibri.beta.bridge.defs#pairingView` | Yes | The pending pairing. |

#### Errors

- **AuthRequired**: The request is missing, malformed, or unverifiable service auth.
- **PairingNotFound**: The code does not exist, has expired, or was already used.

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Describes a pending pairing code so an admin can see which bridge they are about to connect.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The code does not exist, has expired, or was already used.",
          "name": "PairingNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "pairing": {
              "description": "The pending pairing.",
              "ref": "social.colibri.beta.bridge.defs#pairingView",
              "type": "ref"
            }
          },
          "required": [
            "pairing"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "code": {
            "description": "The pairing code.",
            "maxLength": 32,
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.colibri.beta.bridge.getPairing",
  "lexicon": 1
}
```