Fetch connections by user ID

Fetch accepted connections for any user by their ID

Overview

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

For fetching your own connections, see useFetchConnections.

Usage Example

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

function UserConnections({ userId }: { userId: string }) {
  const fetchConnectionsByUserId = useFetchConnectionsByUserId();
  const [connections, setConnections] = useState([]);

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

  return (
    <ul>
      {connections.map(({ id, connectedUser }) => (
        <li key={id}>{connectedUser.name}</li>
      ))}
    </ul>
  );
}

Parameters

The hook returns a function. That function accepts:

userId · string · required

The ID of the user whose connections 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 connected user’s reputation into a spaceReputation number on the embedded connectedUser. 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 established connections:

data · EstablishedConnection[]

Array of accepted connection entries.

Show EstablishedConnection properties

id · string

ID of the connection record.

connectedUser · User

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

connectedAt · string

ISO timestamp when the connection was established.

pagination · object

Pagination metadata including page, pageSize, totalPages, totalItems, and hasMore.

Related

• useFetchConnections — fetch the current user’s own connections
• useFetchConnectionsCountByUserId — get count for any user