Skip to main content

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 "@replyke/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".

Returns

data
SpaceMemberWithUser[]
Array of SpaceMemberWithUser objects including embedded user details.
pagination
object
Standard pagination metadata.