Skip to main content
The spaces module includes a full set of membership management functions. Use these to build admin tools, automate onboarding flows, or enforce membership policies server-side.

​
joinSpace

Adds a user to a space. If the space requires approval (requireJoinApproval: true), the membership is created in a pending state. 
const result = await sublay.spaces.joinSpace({
  spaceId: "spc_abc123",
  userId: "usr_abc123",
});
​
spaceId
string
required
The Sublay space ID.
​
userId
string
required
The Sublay user ID to add.
Returns — Promise<JoinSpaceResponse>

​
leaveSpace

Removes a user from a space. 
const result = await sublay.spaces.leaveSpace({
  spaceId: "spc_abc123",
  userId: "usr_abc123",
});
​
spaceId
string
required
The Sublay space ID.
​
userId
string
required
The Sublay user ID to remove.
Returns — Promise<LeaveSpaceResponse>

​
checkMyMembership

Returns the membership status of a user in a space. 
const result = await sublay.spaces.checkMyMembership({
  spaceId: "spc_abc123",
  userId: "usr_abc123",
});
​
spaceId
string
required
The Sublay space ID.
​
userId
string
required
The Sublay user ID to check.
Returns — Promise<CheckMyMembershipResponse>

​
fetchSpaceMembers

Returns a paginated list of approved members in a space. 
const result = await sublay.spaces.fetchSpaceMembers({
  spaceId: "spc_abc123",
  page: 1,
  limit: 20,
});
​
spaceId
string
required
The Sublay space ID.
​
page
number
Page number (1-indexed). Defaults to 1.
​
limit
number
Results per page. Defaults to 20.
​
role
string
Filter by role: "admin", "moderator", or "member".
​
status
string
Filter by membership status: "pending", "active", "banned", or "rejected".
Returns — Promise<SpaceMembersResponse>

​
fetchSpaceTeam

Returns the admin and moderator members of a space (the “team”). 
const result = await sublay.spaces.fetchSpaceTeam({ spaceId: "spc_abc123" });
​
spaceId
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: "mem_xyz789",
  role: "moderator",
});
​
spaceId
string
required
The Sublay space ID.
​
memberId
string
required
The Sublay space member ID (not the user ID).
​
role
string
required
The new role to assign: "admin", "moderator", or "member".
Returns — Promise<UpdateMemberRoleResponse>

​
approveMembership

Approves a pending membership request. Only relevant when the space has requireJoinApproval: true. 
const result = await sublay.spaces.approveMembership({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
​
spaceId
string
required
The Sublay space ID.
​
memberId
string
required
The Sublay space member ID of the pending member.
Returns — Promise<ApproveMemberResponse>

​
declineMembership

Declines and removes a pending membership request. 
const result = await sublay.spaces.declineMembership({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
​
spaceId
string
required
The Sublay space ID.
​
memberId
string
required
The Sublay space member ID of the pending member.
Returns — Promise<DeclineMemberResponse>

​
banMember

Bans a member from a space, preventing them from rejoining. 
const result = await sublay.spaces.banMember({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
​
spaceId
string
required
The Sublay space ID.
​
memberId
string
required
The Sublay space member ID to ban.
Returns — Promise<BanMemberResponse>

​
unbanMember

Removes a ban, allowing the user to rejoin the space. 
const result = await sublay.spaces.unbanMember({
  spaceId: "spc_abc123",
  memberId: "mem_xyz789",
});
​
spaceId
string
required
The Sublay space ID.
​
memberId
string
required
The Sublay space member ID to unban.
Returns — Promise<UnbanMemberResponse>