Add user to team
Add user to the team by user_id. ##### Permissions Must be authenticated and team be open to add self. For adding another user, authenticated user must have the `add_user_to_team` permission.
Add user to team from invite
Using either an invite id or hash/data pair from an email invite link, add a user to a team. ##### Permissions Must be authenticated.
Add multiple users to team
Add a number of users to the team by user_id. ##### Permissions Must be authenticated. Authenticated user must have the `add_user_to_team` permission.
Get teams
For regular users only returns open teams. Users with the "manage_system" permission will return teams regardless of type. The result is based on query string parameters - page and per_page. ##### Permissions Must be authenticated. "manage_system" permission is required to show all teams.
Get a team by name
Get a team based on provided name string ##### Permissions Must be authenticated, team type is open and have the `view_team` permission.
Get the team icon
Get the team icon of the team. Minimum server version: 4.9 ##### Permissions User must be authenticated. In addition, team must be open or the user must have the `view_team` permission.
Get invite info for a team
Get the `name`, `display_name`, `description` and `id` for a team from the invite id. Minimum server version: 4.0 ##### Permissions No authentication required.
Get team members
Get a page team members list based on query string parameters - team id, page and per page. ##### Permissions Must be authenticated and have the `view_team` permission.
Get team members by ids
Get a list of team members based on a provided array of user ids. ##### Permissions Must have `view_team` permission for the team.
Get team members for a user
Get a list of team members for a user. Useful for getting the ids of teams the user is on and the roles they have in those teams. ##### Permissions Must be logged in as the user or have the `edit_other_users` permission.
Get unreads for a team
Get the unread mention and message counts for a team for the specified user. ##### Permissions Must be the user or have `edit_other_users` permission and have `view_team` permission for the team.
Import a Team from other application
Import a team into a existing team. Import users, channels, posts, hooks. ##### Permissions Must have `permission_import_team` permission.
Invalidate active email invitations
Invalidate active email invitations that have not been accepted by the user. ##### Permissions Must have `sysconsole_write_authentication` permission.
Invite guests to the team by email
Invite guests to existing team channels usign the user's email. The number of emails that can be sent is rate limited to 20 per hour with a burst of 20 emails. If the rate limit exceeds, the error message contains details on when to retry and when the timer will be reset. Minimum server version: 5.16 ##### Permissions Must have `invite_guest` permission for the team.
Invite users to the team by email
Invite users to the existing team using the user's email. The number of emails that can be sent is rate limited to 20 per hour with a burst of 20 emails. If the rate limit exceeds, the error message contains details on when to retry and when the timer will be reset. ##### Permissions Must have `invite_user` and `add_user_to_team` permissions for the team.
Patch a team
Partially update a team by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have the `manage_team` permission.
Regenerate the Invite ID from a Team
Regenerates the invite ID used in invite links of a team ##### Permissions Must be authenticated and have the `manage_team` permission.
Remove the team icon
Remove the team icon for the team. Minimum server version: 4.10 ##### Permissions Must be authenticated and have the `manage_team` permission.
Remove user from team
Delete the team member object for a user, effectively removing them from a team. ##### Permissions Must be logged in as the user or have the `remove_user_from_team` permission.
Search files in a team
Search for files in a team based on file name, extention and file content (if file content extraction is enabled and supported for the files). Minimum server version: 5.34 ##### Permissions Must be authenticated and have the `view_team` permission.
Search teams
Search teams based on search term and options provided in the request body. ##### Permissions Logged in user only shows open teams Logged in user with "manage_system" permission shows all teams
Sets the team icon
Sets the team icon for the team. Minimum server version: 4.9 ##### Permissions Must be authenticated and have the `manage_team` permission.
Delete a team
Soft deletes a team, by marking the team as deleted in the database. Soft deleted teams will not be accessible in the user interface. Optionally use the permanent query parameter to hard delete the team for compliance reasons. As of server version 5.0, to use this feature `ServiceSettings.EnableAPITeamDeletion` must be set to `true` in the server's configuration. ##### Permissions Must have the `manage_team` permission.
Team members minus group members.
Get the set of users who are members of the team minus the set of users who are members of the given groups. Each user object contains an array of group objects representing the group memberships for that user. Each user object contains the boolean fields `scheme_guest`, `scheme_user`, and `scheme_admin` representing the roles that user has for the given team. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.14
Update a team
Update a team by providing the team object. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have the `manage_team` permission.
Update a team member roles
Update a team member roles. Valid team roles are "team_user", "team_admin" or both of them. Overwrites any previously assigned team roles. ##### Permissions Must be authenticated and have the `manage_team_roles` permission.
Update the scheme-derived roles of a team member.
Update a team member's scheme_admin/scheme_user properties. Typically this should either be `scheme_admin=false, scheme_user=true` for ordinary team member, or `scheme_admin=true, scheme_user=true` for a team admin. Minimum server version: 5.0 ##### Permissions Must be authenticated and have the `manage_team_roles` permission.
Update teams's privacy
Updates team's privacy allowing changing a team from Public (open) to Private (invitation only) and back. Minimum server version: 5.24 ##### Permissions `manage_team` permission for the team of the team.
Set a team's scheme
Set a team's scheme, more specifically sets the scheme_id value of a team record. ##### Permissions Must have `manage_system` permission. Minimum server version: 5.0
