# guide.climbers.appview.getRoute

> Published by [gunnar.foo](https://lexicon.garden/identity/did:plc:f5gvem3uvafi2ord4txpyvjj)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:f5gvem3uvafi2ord4txpyvjj/guide.climbers.appview.getRoute)
- [Documentation](https://lexicon.garden/lexicon/did:plc:f5gvem3uvafi2ord4txpyvjj/guide.climbers.appview.getRoute/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:f5gvem3uvafi2ord4txpyvjj/guide.climbers.appview.getRoute/examples)

## Definitions

### `guide.climbers.appview.getRoute`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (at-identifier) | Yes | The repo holding the route record, as a DID or a handle. |
| `rkey` | `string` (record-key) | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `board` | `ref` → `guide.climbers.appview.getWall#boardView` | Yes | The board the route is set on. |
| `route` | `ref` → `guide.climbers.appview.getBoardRoutes#routeView` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "board": {
              "description": "The board the route is set on.",
              "ref": "guide.climbers.appview.getWall#boardView",
              "type": "ref"
            },
            "route": {
              "ref": "guide.climbers.appview.getBoardRoutes#routeView",
              "type": "ref"
            }
          },
          "required": [
            "route",
            "board"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "actor": {
            "description": "The repo holding the route record, as a DID or a handle.",
            "format": "at-identifier",
            "type": "string"
          },
          "rkey": {
            "format": "record-key",
            "type": "string"
          }
        },
        "required": [
          "actor",
          "rkey"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "guide.climbers.appview.getRoute",
  "lexicon": 1
}
```