Backfill in-progress. Some lexicons and records may be missing or incomplete.

app.bsky.graph.getRelationships

bsky-lexicons.bsky.social

Documentation

main query

Enumerates public relationships between one account, and a list of other accounts. Does not require auth.

Parameters

actor string at-identifier Required

Primary account requesting relationships for.

others array of string Optional

List of 'other' accounts to be related back to the primary.

Output

Encodingapplication/json
actor stringdid Optional

A decentralized identifier (DID).

relationships array Required

No description provided.

Errors

ActorNotFound the primary actor at-identifier could not be resolved
Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Primary account requesting relationships for.
List of 'other' accounts to be related back to the primary.
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "ActorNotFound",
      "description": "the primary actor at-identifier could not be resolved"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "relationships"
      ],
      "properties": {
        "actor": {
          "type": "string",
          "format": "did"
        },
        "relationships": {
          "type": "array",
          "items": {
            "refs": [
              "app.bsky.graph.defs#relationship",
              "app.bsky.graph.defs#notFoundActor"
            ],
            "type": "union"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "actor"
    ],
    "properties": {
      "actor": {
        "type": "string",
        "format": "at-identifier",
        "description": "Primary account requesting relationships for."
      },
      "others": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-identifier"
        },
        "maxLength": 30,
        "description": "List of 'other' accounts to be related back to the primary."
      }
    }
  },
  "description": "Enumerates public relationships between one account, and a list of other accounts. Does not require auth."
}

Lexicon Garden

@