club.userstyles.alpha.graph.getRelationship Documentation (EN)

main query

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

Parameters

actor string at-identifier Required

Either a DID or an AT Protocol handle.

other string at-identifier Required

Either a DID or an AT Protocol handle.

Output

Encodingapplication/json

Schemaclub.userstyles.alpha.defs#relationshipView

Errors

ActorNotFound

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

actor * Either a DID or an AT Protocol handle.

other * Either a DID or an AT Protocol handle.

View raw schema

{
  "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."
}