Teams
Teams are groups of your organization's members that work can be assigned to as a whole, and a member's team role adds permissions to their own role. List your organization's teams and who is in each, create a team, and add a member to a team, change their team role or remove them. You can also list the people who can be assigned work, and the roles a team member can have. See Teams.
List your organization's teams
Every team in the workspace's organization, by name, each with its id, description and member count. Teams belong to the organization, so every workspace sees the same ones; list-team-members says who is in one. To assign work to a team, pass { "entityType": "team", "id": "<team id>" } in assignees when you create or update a task, bug report, feature or session, or update a feature request. That list replaces the item's whole assignee set, so include everyone who should stay assigned. Every member of the team is notified, except the person who made the assignment. List filters take a team id as assigneeId, or my-teams for every team the caller is on. A member's team role adds permissions to those of their own role.
path Parameters
workspaceIdWorkspace UUID
List your organization's teams › Responses
The organization's teams
Create a team
Creates a team in the workspace's organization, with no members yet: add them with add-team-member. Teams belong to the organization, so every workspace sees the new one. To assign work to a team, pass { "entityType": "team", "id": "<team id>" } in assignees when you create or update a task, bug report, feature or session, or update a feature request. That list replaces the item's whole assignee set, so include everyone who should stay assigned. Every member of the team is notified, except the person who made the assignment. List filters take a team id as assigneeId, or my-teams for every team the caller is on. Needs permission to manage teams, which Owners and Admins have by default: without it the call answers 403 and changes nothing, and retrying will not help. 409 when the organization already has a team with this name.
path Parameters
workspaceIdWorkspace UUID
Create a team › Request Body
nameThe team's name, unique within the organization.
descriptionWhat the team owns or works on.
Create a team › Responses
The team, with no members
List a team's members
Everyone in a team, each with their user id, name, email and team role. A team role adds permissions to those of the member's own role. 404 when the team is not in the workspace's organization.
path Parameters
workspaceIdWorkspace UUID
teamIdThe team's id, from list-teams
List a team's members › Responses
The team's members, longest-standing first
Add a member to a team
Adds a person to a team with the team role chosen for them. Find the team with list-teams, the person with list-assignable-users and the roles they can be given with list-team-roles. The team role is required, and it is the choice of the person who asked for the change: if they have not said which role, ask them, and never pick one for them. A team role adds its permissions to the member's own role, so an Admin team role gives Admin capabilities. Being on a team also lets the member see every private feature whose access list names the team, and edit it where the list says Can edit. Needs permission to manage teams, which Owners and Admins have by default: without it the call answers 403 and changes nothing, and retrying will not help. 400 when the person is not an active member of the organization, or the role is Owner or not one of the organization's roles; 404 when the team is not found; 409 when they are already on the team.
path Parameters
workspaceIdWorkspace UUID
teamIdThe team's id, from list-teams
Add a member to a team › Request Body
userId^([0-9a-fA-F]{8}-[0-… · requiredThe person to add, by user id: from list-assignable-users. They must be an active member of the organization.
role^[a-z0-9-]+$ · requiredThe team role to give them: a role key from list-team-roles, such as developer or a custom role's key, never owner. The person you act for chooses it: if they have not said which role, ask them, offering the roles list-team-roles returns. Never pick one yourself.
Add a member to a team › Responses
The new membership, with its team role
Remove a member from a team
Takes a person off a team. Within about 30 seconds they lose the permissions the team role gave them and the private features they could see only through the team. Work assigned to the team stays assigned to it. Needs permission to manage teams, which Owners and Admins have by default: without it the call answers 403 and changes nothing, and retrying will not help. 404 when the team is not found or the person is not on it.
path Parameters
workspaceIdWorkspace UUID
teamIdThe team's id, from list-teams
userIdThe member's user id, from list-team-members
Remove a member from a team › Responses
Team member removed
Change a member's team role
Gives a team member a different team role; list-team-roles has the choices. The team role is required, and it is the choice of the person who asked for the change: if they have not said which role, ask them, and never pick one for them. A higher team role means more permissions: an Admin team role gives Admin capabilities. Needs permission to manage teams, which Owners and Admins have by default: without it the call answers 403 and changes nothing, and retrying will not help. 400 when the role is Owner or not one of the organization's roles; 404 when the team is not found or the person is not on it.
path Parameters
workspaceIdWorkspace UUID
teamIdThe team's id, from list-teams
userIdThe member's user id, from list-team-members
Change a member's team role › Request Body
role^[a-z0-9-]+$ · requiredThe team role to give them: a role key from list-team-roles, such as developer or a custom role's key, never owner. The person you act for chooses it: if they have not said which role, ask them, offering the roles list-team-roles returns. Never pick one yourself.
Change a member's team role › Responses
The membership, with its new team role
List the roles a team member can have
The roles add-team-member and update-team-member can give: the organization's built-in and custom roles, each with its key, name and description. Owner is never a team role. Offer these when the person who asked has not said which role to give; the app's Add member dialog starts on Power User. Needs permission to manage teams, which Owners and Admins have by default; without it the call answers 403.
path Parameters
workspaceIdWorkspace UUID
List the roles a team member can have › Responses
The roles a team member can have
List the people you can assign work to
The active members of the workspace's organization, the people who can be assigned work or added to a team, each with their user id, name and email. Pass search to keep only the people whose name or email contains it. At most 100, by name. A person's id goes in assignees as { "entityType": "user", "id": "<user id>" }, and in userId on add-team-member.
path Parameters
workspaceIdWorkspace UUID
query Parameters
searchKeep only the people whose name or email contains this text, ignoring case.
List the people you can assign work to › Responses
The people who can be assigned work