Teams

Teams are organizational units that allow organization owners to group users together, managing team members and access permissions as a whole.

Path and query parameters

Name	Type	Location	Req/Opt	Description
orgId	integer	path	Required	Organization identifier.
max	integer	query	Optional	Maximum number of results to return. Default: 50.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
search	string	query	Optional	Free-text search filter to match against team names.
name	string	query	Optional	The team name to validate for availability and format compliance within the organization.
teamId	integer	path	Required	Team identifier.
memberId	integer	path	Required	Member identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateOrganizationTeam			Create organization team
team	object	Optional	Team in an organization. Teams group organization members to simplify workspace access management.
team.id	integer	Optional	Team identifier.
team.name	string	Required	Unique team name within the organization.
team.description	string	Optional	Optional description of the team.
team.dateCreated	string	Optional	Timestamp when the team was created.
team.lastUpdated	string	Optional	Timestamp when the team was last updated.
avatarId	string	Optional	Avatar image identifier for the team. See Create avatar to upload images and obtain an avatar ID.
idpGroupId	integer	Optional	Identity provider (IdP) group identifier to delegate team membership to. Team members are then synchronized from the IdP group at login. Set to null to create a manually managed team. Ignored if IdP claims mapping is not enabled for the organization.
UpdateOrganizationTeam			Update organization team
name	string	Optional	Updated team name. Must remain unique within the organization.
description	string	Optional	Updated team description.
avatarId	string	Optional	Updated avatar image identifier for the team. See Create avatar to upload images and obtain an avatar ID.
idpGroupId	integer	Optional	Identity provider (IdP) group identifier to delegate team membership to. Omit to leave the delegation unchanged, or set to null to remove it. Ignored if IdP claims mapping is not enabled for the organization.
CreateOrganizationTeamMember			Create team member
userNameOrEmail	string	Optional	Username or email address of the organization member to add to the team.