Teams

Team Permissions

GET/api/v2/teams/

This endpoint allows the authenticated user to retrieve a list of all Teams of the Organization they belong to. Query Parameters: query (str): Filter...

POST/api/v2/teams/

This endpoint allows the authenticated user to create a new Team in their Organization. Request Body: team_name (str): The name of the team to create...

GET/api/v2/teams/{team_id}

This endpoint allows the authenticated user to retrieve a specific team by team_id. Path Parameters: team_id (int): The ID of the team to retrieve. ...

PUT/api/v2/teams/{team_id}

This endpoint allows the authenticated user to update a specific team by team_id. Path Parameters: team_id (int): The ID of the team to update. Requ...

DELETE/api/v2/teams/{team_id}

This endpoint allows the authenticated user to delete a specific team by team_id. Path Parameters: team_id (int): The ID of the team to delete. Requ...

Get a team's permission sets and effective permissions

GET/api/v2/teams/{team_id}/permission-sets

Returns every permission set assigned to the team, plus the union of thescopes they grant together. effective_permissions describes what a member can ...

Preview a team's permissions after assigning/removing permission sets

POST/api/v2/teams/{team_id}/permission-sets/preview

Compute exactly which actions the team WOULD grant its members afterassigning and/or unassigning the given permission sets. Nothing is written —this i...

Get all Projects of a Team

GET/api/v2/teams/{team_id}/projects

Retrieve all active (non-deleted) projects for a specific team. Path Parameters: team_id (int): The ID of the team for which projects are being retri...

Create a Recent Team

POST/api/v2/teams/{team_id}/recent

This endpoint allows users to add a team to the list of recently accessed teams.By providing the team_id, the specified team is marked as recently acc...

Get all Users in a Team

GET/api/v2/teams/{team_id}/users

This endpoint allows you to retrieve a comprehensive list of users who are part of a specific team. Path Parameters: team_id (int): The ID of the tea...

Add Users to a Team

POST/api/v2/teams/{team_id}/users

This endpoint allows you to add users to a specific team. Path Parameters: team_id (int): The ID of the team to which users are to be added Request ...

Remove User from Team

DELETE/api/v2/teams/{team_id}/users/{user_id}

This endpoint allows you to remove a user from a team. It also removes the user from all the projects and agents associated with the team. Path Parame...

Update User Role in Team

PUT/api/v2/teams/{team_id}/users/{user_id}/role

This endpoint allows you to update the role of a user in a team. Path Parameters: team_id (int): The ID of the team whose user's role is to be up...

Get Recent Teams

GET/api/v2/teams/recent

This endpoint allows users to retrieve a list of recently created teams within an organization.It provides detailed information about each team, inclu...

Get all Teams of the Authenticated User

GET/api/v2/teams/users

This endpoint allows the authenticated user to retrieve a list of teams they belong to, along with the information about each team.It provides insight...

Get all Agents of User's Teams

GET/api/v2/teams/users/{user_id}/agents

This endpoint allows you to retrieve a detailed list of agents associated with a specific user's teams. Path Parameters: user_id (int): The ID of...

Create a new Conversation Starter.

List all permissions on a team