Fetch space members

Fetch a paginated list of members in a space

Overview

useFetchSpaceMembers returns a callable function that fetches the member list for a space. Each result includes embedded public user data. Results are paginated and can be filtered by role or status.

Usage Example

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

function MemberList({ spaceId }: { spaceId: string }) {
  const fetchMembers = useFetchSpaceMembers();

  const loadMembers = async () => {
    const result = await fetchMembers({ spaceId, page: 1, limit: 20 });
    result.data.forEach(({ user, role, status }) => {
      console.log(user.displayName, role, status);
    });
  };
}

Parameters

spaceId · string · required

UUID of the space.

page · number

Page number. Defaults to 1.

limit · number

Number of members per page.

status · string

Filter by membership status: "pending", "active", "banned", or "rejected".

role · string

Filter by role: "admin", "moderator", or "member".

spaceReputationId · string

Resolves each member’s reputation into a spaceReputation number on the embedded user. Accepts a space <uuid>, "none" (project-general bucket), or "context" (server-derived from the request context). Empty string, "general", and null are 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

data · SpaceMemberWithUser[]

Array of SpaceMemberWithUser objects including embedded user details. When spaceReputationId is set, each embedded user carries an added spaceReputation number. See Reputation.

pagination · object

Standard pagination metadata.