app.bsky.graph.getRelationships

GET 
/xrpc/app.bsky.graph.getRelationships

This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

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

Request

Query Parameters

actor at-identifierrequired

Primary account requesting relationships for.

others at-identifier[]

Possible values: <= 30

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

Responses

200

OK

application/json

Schema

Schema

actor did

relationships

object[]

required

Array [

oneOf

app.bsky.graph.defs.relationship

did didrequired

following at-uri

if the actor follows this DID, this is the AT-URI of the follow record

followedBy at-uri

if the actor is followed by this DID, contains the AT-URI of the follow record

app.bsky.graph.defs.notFoundActor

actor at-identifierrequired

notFound booleanrequired

Default value: true

]

Example (from schema)

{
  "actor": "string",
  "relationships": [
    {},
    {}
  ]
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken, ActorNotFound]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...