# ink.resenha.parlor.getRelationship

> Requires the caller's service token.

- Kind: query
- Authority: parlor.resenha.ink
- Lexicon: 1
- Published by [resenha.ink](https://lexicon.garden/identity/did:plc:v7itjf4h3sb5zuegiiskctqb), not the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.parlor.getRelationship)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.parlor.getRelationship/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:v7itjf4h3sb5zuegiiskctqb/ink.resenha.parlor.getRelationship/analytics)

## Query (`ink.resenha.parlor.getRelationship`)

Type: query · GET

### Parameters (query string)

- `actor` (string · did, required)

### Output (application/json)

- `did` (string · did, required)
- `following` (boolean): The caller follows them.
- `followsYou` (boolean): They follow the caller.
- `knownFollowers` (ref)
  - Reference: `ink.resenha.defs#knownFollowers`
- `profiles` (array): The names and pictures of the known followers named.
  - `items` (ref)
    - Reference: `ink.resenha.defs#profileView`

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Requires the caller's service token.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "did": {
              "format": "did",
              "type": "string"
            },
            "following": {
              "description": "The caller follows them.",
              "type": "boolean"
            },
            "followsYou": {
              "description": "They follow the caller.",
              "type": "boolean"
            },
            "knownFollowers": {
              "ref": "ink.resenha.defs#knownFollowers",
              "type": "ref"
            },
            "profiles": {
              "description": "The names and pictures of the known followers named.",
              "items": {
                "ref": "ink.resenha.defs#profileView",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "did"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "actor": {
            "format": "did",
            "type": "string"
          }
        },
        "required": [
          "actor"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "description": "How the caller and another reader stand to each other, as Resenha's server knows it: whether each follows the other, and which of the caller's follows follow them, for \"followed by people you follow\" on a profile.",
  "id": "ink.resenha.parlor.getRelationship",
  "lexicon": 1
}
```