# club.userstyles.alpha.graph.getRelationship

> Published by [userstyles.club](https://lexicon.garden/identity/did:plc:z6a2tfjek74wmqinw5vjzbed)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.graph.getRelationship)
- [Documentation](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.graph.getRelationship/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.graph.getRelationship/examples)

## Definitions

### `club.userstyles.alpha.graph.getRelationship`

**Type**: `query`

Check the follow relationship between two actors: whether `actor` follows `other`, and whether `other` follows `actor` back.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (at-identifier) | Yes |  |
| `other` | `string` (at-identifier) | Yes |  |

#### Output

**Encoding**: `application/json`

#### Errors

- **ActorNotFound**

## Raw Schema

```json
{
  "id": "club.userstyles.alpha.graph.getRelationship",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "ActorNotFound"
        }
      ],
      "output": {
        "schema": {
          "ref": "club.userstyles.alpha.defs#relationshipView",
          "type": "ref"
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "actor",
          "other"
        ],
        "properties": {
          "actor": {
            "type": "string",
            "format": "at-identifier"
          },
          "other": {
            "type": "string",
            "format": "at-identifier"
          }
        }
      },
      "description": "Check the follow relationship between two actors: whether `actor` follows `other`, and whether `other` follows `actor` back."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```