Skip to main content

Members

Complete reference for member-related methods.

Methods​

get_space_members​

get_space_members() -> GetSpaceMembersResponse

Get all members in the current space.

Returns: GetSpaceMembersResponse with list of members

Example:

# Get all space members
response = client.get_space_members()

print(f"Total members: {len(response.members)}")
for member in response.members:
    print(f"- {member.full_name} ({member.email})")

Models​

Member​

Main member model representing a space member.

class Member:
    id: str                    # Member ID
    nick_name: Optional[str]   # Nickname
    full_name: Optional[str]   # Full name
    email: str                 # Email address
    avatar: Optional[str]      # Avatar URL
    avatar_mode: AvatarMode    # Avatar display mode (Uploaded=0, Generated=2)
    color: ColorInfo           # Color configuration
    space: str                 # Space ID
    status: str                # Member status (e.g., "Active")
    joined_date: str           # Join date as string
    updated_at: str            # Last update date as string

ColorInfo​

Color configuration shared across spaces, members, and profiles.

class ColorInfo:
    color: str        # Hex color code (e.g., "#a8f8b8")
    is_dark: bool     # Brightness flag - True if color is dark (for UI text contrast)

Response Models​

GetSpaceMembersResponse​

Response containing list of space members.

class GetSpaceMembersResponse:
    type: str                       # Response type ("GetSpaceMembers")
    payload: GetSpaceMembersPayload # Response payload
    
    @property
    def members(self) -> List[Member]:  # Convenience property to access members
        ...

GetSpaceMembersPayload​

Payload wrapper for members list.

class GetSpaceMembersPayload:
    members: List[Member]      # List of space members

See Also​