LegacyTeams
Legacy teams allow you to form groups of users withing the organization for more efficient management. Previously Legacy Teams were called Teams and occupied the v1/teams* path. They're being deprecated because we are preparing for an upgraded version of the Teams API, which requires migrating the current functionality to a new path URL v1/legacyTeams*. The functionality and OAuth scopes of all the Teams API endpoints will remain the same.
Get all teams
Returns data about teams within the company.
Request
/v1/legacyTeams
Query parameters
order_by
string
The field name to sort returned teams by
Default
id
Values
id
name
manager_id
active_flag
skip_users
number
When enabled, the teams will not include IDs of member users
Default
0
Values
0
1
Response
OK
Expand all
Copy code- true
- [ ... ]▶
Get a single team
Returns data about a specific team.
Request
/v1/legacyTeams/{id}
Path parameters
id
integer
required
The ID of the team
Query parameters
skip_users
number
When enabled, the teams will not include IDs of member users
Default
0
Values
0
1
Response
OK
Expand allCopy code- true
- { ... }▶
Get all users in a team
Returns a list of all user IDs within a team.
Request
/v1/legacyTeams/{id}/users
Path parameters
id
integer
required
The ID of the team
Response
OK
Expand allCopy code- true
- [ ... ]▶
Get all teams of a user
Returns data about all teams which have the specified user as a member.
Request
/v1/legacyTeams/user/{id}
Path parameters
id
integer
required
The ID of the user
Query parameters
order_by
string
The field name to sort returned teams by
Default
id
Values
id
name
manager_id
active_flag
skip_users
number
When enabled, the teams will not include IDs of member users
Default
0
Values
0
1
Response
OK
Expand allCopy code- true
- [ ... ]▶
Add a new team
Adds a new team to the company and returns the created object.
Request
/v1/legacyTeams
Body parameters
application/json
name
string
required
The team name
description
string
The team description
manager_id
integer
required
The team manager ID
users
array
The list of user IDs
Response
OK
Expand allCopy code- true
- { ... }▶
Add users to a team
Adds users to an existing team.
Request
/v1/legacyTeams/{id}/users
Path parameters
id
integer
required
The ID of the team
Body parameters
application/json
users
array
required
The list of user IDs
Response
OK
Expand allCopy code- true
- [ ... ]▶
Update a team
Updates an existing team and returns the updated object.
Request
/v1/legacyTeams/{id}
Path parameters
id
integer
required
The ID of the team
Body parameters
application/json
name
string
The team name
description
string
The team description
manager_id
integer
The team manager ID
users
array
The list of user IDs
active_flag
Flag that indicates whether the team is active
Values
0
1
deleted_flag
Flag that indicates whether the team is deleted
Values
0
1
Response
OK
Expand allCopy code- true
- { ... }▶
Delete users from a team
Deletes users from an existing team.
Request
/v1/legacyTeams/{id}/users
Path parameters
id
integer
required
The ID of the team
Body parameters
application/json
users
array
required
The list of user IDs
Response
OK
Expand allCopy code- true
- [ ... ]▶