Fetch followers by user ID

Fetch the followers of any user by their ID

Overview

Returns a function that fetches the paginated list of followers for any user, identified by userId. This is a public endpoint — authentication is not required.

For fetching your own followers, see useFetchFollowers.

Usage Example

import { useFetchFollowersByUserId } from "@sublay/react-js";

function UserFollowers({ userId }: { userId: string }) {
  const fetchFollowersByUserId = useFetchFollowersByUserId();
  const [followers, setFollowers] = useState([]);

  useEffect(() => {
    fetchFollowersByUserId({ userId, page: 1 }).then((res) => {
      setFollowers(res.data);
    });
  }, [userId]);

  return (
    <ul>
      {followers.map(({ followId, user }) => (
        <li key={followId}>{user.name}</li>
      ))}
    </ul>
  );
}

Parameters

The hook returns a function. That function accepts:

userId · string · required

The ID of the user whose followers to fetch.

page · number

Page number to fetch. Defaults to 1.

limit · number

Number of results per page. Defaults to 20.

spaceReputationId · string

Resolves each follower’s reputation into a spaceReputation number on the embedded user. Accepts a space <uuid> or "none" (project-general bucket) only — "context" is rejected with a 400 on this endpoint. Empty string, "general", and null are also rejected. See Reputation.

spaceReputationDescendants · boolean

When true, spaceReputation is the subtree sum (the space plus all its descendants). Only honored when spaceReputationId is an explicit <uuid>.

Returns

Returns a PaginatedResponse containing an array of follower entries:

data · FollowerWithFollowInfo[]

Array of follower entries.

Show FollowerWithFollowInfo properties

followId · string

ID of the follow record.

user · User

The follower’s user profile. When spaceReputationId is set, it carries an added spaceReputation number. See User data model and Reputation.

followedAt · string

ISO timestamp of when the follow was created.

pagination · object

Pagination metadata including currentPage, totalPages, totalCount, hasNextPage, and hasPreviousPage.

Related

• useFetchFollowers — fetch the current user’s own followers
• useFetchFollowersCountByUserId — get follower count for a user