Space Members

The space membership functions let the logged-in user join and leave spaces, and let admins and moderators manage a space’s membership — roles, pending approvals, and bans.

joinSpace

Joins a space as the logged-in user, or requests to join if the space requires approval.

const result = await sublay.spaces.joinSpace({ spaceId: "spc_abc123" });

string

required

The Sublay space ID.

Returns — Promise<JoinSpaceResponse>

leaveSpace

Leaves a space as the logged-in user.

const result = await sublay.spaces.leaveSpace({ spaceId: "spc_abc123" });

string

required

The Sublay space ID.

Returns — Promise<LeaveSpaceResponse>

checkMyMembership

Checks the logged-in user’s membership status in a space.

const membership = await sublay.spaces.checkMyMembership({
  spaceId: "spc_abc123",
});

string

required

The Sublay space ID.

Returns — Promise<CheckMyMembershipResponse>

fetchSpaceMembers

Fetches a paginated list of a space’s members, filterable by role and status.

const members = await sublay.spaces.fetchSpaceMembers({
  spaceId: "spc_abc123",
  role: "member",
  status: "active",
});

string

required

The Sublay space ID.

number

The page number to fetch.

number

The number of members to return per page.

string

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

string

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

Returns — Promise<SpaceMembersResponse>

fetchSpaceTeam

Fetches the team (admins and moderators) of a space.

const team = await sublay.spaces.fetchSpaceTeam({ spaceId: "spc_abc123" });

string

required

The Sublay space ID.

Returns — Promise<SpaceTeamResponse>

updateMemberRole

Updates a member’s role within a space.

const result = await sublay.spaces.updateMemberRole({
  spaceId: "spc_abc123",
  memberId: "mbr_xyz789",
  role: "moderator",
});

string

required

The Sublay space ID.

string

required

The membership ID of the member to update.

string

required

The new role: "admin", "moderator", or "member".

Returns — Promise<UpdateMemberRoleResponse>

approveMembership

Approves a pending membership request.

const result = await sublay.spaces.approveMembership({
  spaceId: "spc_abc123",
  memberId: "mbr_xyz789",
});

string

required

The Sublay space ID.

string

required

The membership ID of the pending member.

Returns — Promise<ApproveMemberResponse>

declineMembership

Declines a pending membership request.

const result = await sublay.spaces.declineMembership({
  spaceId: "spc_abc123",
  memberId: "mbr_xyz789",
});

string

required

The Sublay space ID.

string

required

The membership ID of the pending member.

Returns — Promise<DeclineMemberResponse>

banMember

Bans a member from a space.

const result = await sublay.spaces.banMember({
  spaceId: "spc_abc123",
  memberId: "mbr_xyz789",
});

string

required

The Sublay space ID.

string

required

The membership ID of the member to ban.

Returns — Promise<{ message: string; membership: { id: string; status: "banned" } }>

unbanMember

Unbans a previously banned member.

const result = await sublay.spaces.unbanMember({
  spaceId: "spc_abc123",
  memberId: "mbr_xyz789",
});

string

required

The Sublay space ID.

string

required

The membership ID of the member to unban.

Returns — Promise<{ message: string; membership: { id: string; status: "active" } }>

Getting Started

Modules

joinSpace

leaveSpace

checkMyMembership

fetchSpaceMembers

fetchSpaceTeam

updateMemberRole

approveMembership

declineMembership

banMember

unbanMember

​joinSpace

​leaveSpace

​checkMyMembership

​fetchSpaceMembers

​fetchSpaceTeam

​updateMemberRole

​approveMembership

​declineMembership

​banMember

​unbanMember

joinSpace

leaveSpace

checkMyMembership

fetchSpaceMembers

fetchSpaceTeam

updateMemberRole

approveMembership

declineMembership

banMember

unbanMember