This is a detailed reference for the TeamUser and ServerTeamUser objects in the React SDK.
On this page:
TeamUser
The TeamUser object is used on the client side to represent a user in the context of a team, providing minimal information about the user, including their ID and team-specific profile.
It is usually obtained by calling team.useUsers() or team.listUsers() on a Team object.
Table of Contents
type TeamUser = {
id: string;
teamProfile: TeamProfile;
};teamUser.id
The ID of the user.
declare const id: string;teamUser.teamProfile
The team profile of the user as a TeamProfile object.
declare const teamProfile: TeamProfile;ServerTeamUser
The ServerTeamUser object is used on the server side to represent a user within a team. Besides the team profile, it also includes all the functionality of a ServerUser.
It is usually obtained by calling serverTeam.listUsers() on a ServerTeam object.
Table of Contents
type ServerTeamUser =
// Inherits all functionality from TeamUser
TeamUser &
// Inherits all functionality from ServerUser
ServerUser & {
teamProfile: ServerTeamProfile;
};serverTeamUser.teamProfile
The team profile of the user as a ServerTeamProfile object.
declare const teamProfile: ServerTeamProfile;