Skip to main content
The follows module acts on your own follow graph — the graph of the logged-in token holder. Use it to list the users you follow, list your followers, count either, and delete one of your follow relationships by its record ID.
To read another user’s followers, or to follow or unfollow someone by their user ID, use the users module.

​
fetchFollowing

Returns a paginated list of users you follow.
​
page
number
Page number (1-indexed). Defaults to 1.
​
limit
number
Results per page. Defaults to 20.
​
query
string
Optional search term. Filters the list to users whose username or name contains this text (case-insensitive). When omitted, no filtering is applied.
​
searchFields
string
Restricts which field query matches against — username or name. When omitted, query matches either field.
Returns — Promise<PaginatedResponse<FollowListItem>>, where FollowListItem is { followId, user, followedAt }.

​
fetchFollowers

Returns a paginated list of your followers.
​
page
number
Page number (1-indexed). Defaults to 1.
​
limit
number
Results per page. Defaults to 20.
​
query
string
Optional search term. Filters the list to users whose username or name contains this text (case-insensitive). When omitted, no filtering is applied.
​
searchFields
string
Restricts which field query matches against — username or name. When omitted, query matches either field.
Returns — Promise<PaginatedResponse<FollowListItem>>

​
fetchFollowingCount

Returns the number of users you follow.
Returns — Promise<{ count: number }>

​
fetchFollowersCount

Returns the number of your followers.
Returns — Promise<{ count: number }>

​
deleteFollow

Deletes one of your follow relationships by its follow ID.
​
followId
string
required
The ID of the follow relationship to delete.
Returns — Promise<void>