Return the count and a sample of accounts the authenticated viewer follows who also follow the given subject. Viewer-relative: requires authentication (AuthRequired when logged out). A block in either direction between the viewer and the subject returns Unavailable. The count may exceed the returned sample (capped by limit).
Parameters
Output
application/jsoncount
integer
Required
Total number of accounts the viewer follows who also follow the subject; may exceed the returned sample.
followers
array
Required
A sample (≤ limit) of known followers, each a medium profileView.
Errors
AuthRequired
The caller is not authenticated; known-follower lookup is viewer-relative and requires a session. Unavailable
A block exists in either direction between the viewer and the subject account; the known-follower list is not available. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Return the count and a sample of accounts the authenticated viewer follows who also follow the given subject. Viewer-relative: requires authentication (AuthRequired when logged out). A block in either direction between the viewer and the subject returns Unavailable. The count may exceed the returned sample (capped by limit).",
"errors": [
{
"description": "The caller is not authenticated; known-follower lookup is viewer-relative and requires a session.",
"name": "AuthRequired"
},
{
"description": "A block exists in either direction between the viewer and the subject account; the known-follower list is not available.",
"name": "Unavailable"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"count": {
"description": "Total number of accounts the viewer follows who also follow the subject; may exceed the returned sample.",
"type": "integer"
},
"followers": {
"description": "A sample (≤ limit) of known followers, each a medium profileView.",
"items": {
"ref": "community.gifthood.actor.defs#profileView",
"type": "ref"
},
"type": "array"
}
},
"required": [
"count",
"followers"
],
"type": "object"
}
},
"parameters": {
"properties": {
"actor": {
"description": "DID of the subject account.",
"format": "did",
"type": "string"
},
"limit": {
"default": 50,
"description": "Maximum number of known followers to return in the sample.",
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
"required": [
"actor"
],
"type": "params"
},
"type": "query"
}