> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sublay.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Space Members
> Manage space membership — joining, leaving, approvals, role assignments, and bans
export const SpaceReputationParams = ({variant = "context", field = "path"}) => {
const isUser = variant === "user";
return <>
Opt-in. Adds a spaceReputation number to each returned user,
scoped to a single space. Requires the reputation bundle.
The reputation total is always present regardless;{" "}
spaceReputation is purely additive and only appears when you
pass this object. This object is the primary form — it
replaces the deprecated flat props below. See the{" "}
Reputation data model for the
full contract.
{isUser ?
Which bucket to read. A space <uuid> reads that
space's bucket; "none" reads the
project-general (space-less) bucket.{" "}
"context" is rejected (400) on this
endpoint — there is no space context to derive. The empty string
and the legacy general / null aliases are
also rejected. Missing buckets read as 0.
:
Which bucket to read. One of: a space <uuid>{" "}
(that space's bucket), "none" (the
project-general, space-less bucket), or{" "}
"context" (the space derived from the
request context — resolved per-row on lists, or the single space on
member/team/conversation surfaces). The empty string and the legacy{" "}
general / null aliases are rejected (400).
Missing buckets read as 0.
}
Only honored when spaceId is an explicit space <uuid>.
When true, spaceReputation is the{" "}
subtree sum — the named space plus all of its
descendant spaces (the root space's own bucket included). Ignored for{" "}
"none"; not allowed with "context".
{isUser ?
Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid> or "none" only —{" "}
"context" is rejected (400) on this endpoint.
:
Deprecated — use the spaceReputation{" "}
object instead. The flat form of spaceReputation.spaceId.
Still accepted (the object wins if both are passed); removal is a later
major version. Accepts a space <uuid>, "none", or{" "}
"context".
}
Deprecated — use{" "}
spaceReputation.includeDescendants instead. The flat form,
only honored alongside an explicit spaceReputationId <uuid>.
;
};
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.
```typescript theme={null}
const result = await sublay.spaces.joinSpace({
spaceId: "spc_abc123",
userId: "usr_abc123",
});
```
The Sublay space ID.
The Sublay user ID to add.
**Returns** — `Promise`
***
### leaveSpace
Removes a user from a space.
```typescript theme={null}
const result = await sublay.spaces.leaveSpace({
spaceId: "spc_abc123",
userId: "usr_abc123",
});
```
The Sublay space ID.
The Sublay user ID to remove.
**Returns** — `Promise`
***
### checkMyMembership
Returns the membership status of a user in a space.
```typescript theme={null}
const result = await sublay.spaces.checkMyMembership({
spaceId: "spc_abc123",
userId: "usr_abc123",
});
```
The Sublay space ID.
The Sublay user ID to check.
**Returns** — `Promise`
***
### fetchSpaceMembers
Returns a paginated list of approved members in a space.
```typescript theme={null}
const result = await sublay.spaces.fetchSpaceMembers({
spaceId: "spc_abc123",
page: 1,
limit: 20,
});
```
The Sublay space ID.
Page number (1-indexed). Defaults to `1`.
Results per page. Defaults to `20`.
Filter by role: `"admin"`, `"moderator"`, or `"member"`.
Filter by membership status: `"pending"`, `"active"`, `"banned"`, or `"rejected"`.
**Returns** — `Promise`
***
### fetchSpaceTeam
Returns the admin and moderator members of a space (the "team").
```typescript theme={null}
const result = await sublay.spaces.fetchSpaceTeam({ spaceId: "spc_abc123" });
```
The Sublay space ID.
**Returns** — `Promise`
***
### updateMemberRole
Updates a member's role within a space.
```typescript theme={null}
const result = await sublay.spaces.updateMemberRole({
spaceId: "spc_abc123",
memberId: "mem_xyz789",
role: "moderator",
});
```
The Sublay space ID.
The Sublay space member ID (not the user ID).
The new role to assign: `"admin"`, `"moderator"`, or `"member"`.
**Returns** — `Promise`
***
### approveMembership
Approves a pending membership request. Only relevant when the space has `requireJoinApproval: true`.
```typescript theme={null}
const result = await sublay.spaces.approveMembership({
spaceId: "spc_abc123",
memberId: "mem_xyz789",
});
```
The Sublay space ID.
The Sublay space member ID of the pending member.
**Returns** — `Promise`
***
### declineMembership
Declines and removes a pending membership request.
```typescript theme={null}
const result = await sublay.spaces.declineMembership({
spaceId: "spc_abc123",
memberId: "mem_xyz789",
});
```
The Sublay space ID.
The Sublay space member ID of the pending member.
**Returns** — `Promise`
***
### banMember
Bans a member from a space, preventing them from rejoining.
```typescript theme={null}
const result = await sublay.spaces.banMember({
spaceId: "spc_abc123",
memberId: "mem_xyz789",
});
```
The Sublay space ID.
The Sublay space member ID to ban.
Why the member is banned; kept in the space's ban log.
**Returns** — `Promise`
***
### unbanMember
Removes a ban, allowing the user to rejoin the space.
```typescript theme={null}
const result = await sublay.spaces.unbanMember({
spaceId: "spc_abc123",
memberId: "mem_xyz789",
});
```
The Sublay space ID.
The Sublay space member ID to unban.
**Returns** — `Promise`
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.