Introduction

The WorkComposer Teams API allows you to manage team structures within your organization. Use these endpoints to create, retrieve, update, and delete teams, as well as manage team memberships.

Teams are a powerful way to organize users in WorkComposer, enabling you to assign tasks and projects to groups rather than individuals. This API is particularly useful for synchronizing team structures with your HR systems, automating team creation, and maintaining consistent team assignments across your organization.

This endpoint returns a list of all teams in your workspace or details about a specific team if a team ID is provided. The response includes basic team information such as ID and name.

{
  "status": 1,
  "teams": [
    {
      "id": "673e023101ca9fffc0221bd6",
      "name": "Sales and Marketing Team"
    },
    {
      "id": "672b9e79be5907f92431b6c0",
      "name": "Development Team"
    },
    {
      "id": "66ba3dfb288f16f18d7786a0",
      "name": "QA Team"
    }
  ]
}

        

This endpoint allows you to create a new team in your workspace. You can specify the team name and optionally add members during creation.

{
  "status": 1,
  "teamId": "673e023101ca9fffc0221bd6"
}

        

This endpoint allows you to update an existing team's details, including its name and member list. You only need to include the fields you want to update.

{
  "status": 1
}

        

This endpoint allows you to permanently delete a team from your workspace. Use with caution as this action cannot be undone. Note that deleting a team does not delete the users who were members of the team.

{
  "status": 1
}