Overview

A teamspace groups workspace members and links them to projects. It does not own work items or cycles. The work items and cycles shown in a teamspace come from its linked projects.

Learn more about Teamspaces

These pages describe the v1 API under /api/v1/. A v2 API exists at /api/v2/workspaces/{workspace_slug}/teamspaces/ with a different contract: it uses lead_id instead of lead, takes inline member_ids and project_ids that replace the whole set on write, does not check the Teamspaces feature flag, and does not add the lead as a member. This reference does not cover v2 yet.

Every v1 teamspace route requires the Teamspaces feature to be on for the workspace. If it is off, the API returns 403 with the message Payment required. Upgrade your plan to access Teamspaces.

The Teamspace Object

Attributes

• id uuid

  Unique identifier for the teamspace.

• name string (required)

  Name of the teamspace.

• description_json object

  JSON representation of the teamspace description.

• description_html string

  HTML-formatted description of the teamspace.

• description_stripped string

  Plain-text version of the HTML description.

• description_binary string

  Binary form of the description, or null.

• logo_props object

  Logo of the teamspace. in_use is emoji or icon, with a matching emoji or icon object.

• lead uuid

  ID of the user who leads the teamspace, or null.

• workspace uuid

  ID of the workspace containing the teamspace.

• created_at timestamp

  Time at which the teamspace was created.

• updated_at timestamp

  Time at which the teamspace was last updated.

• deleted_at timestamp

  Time at which the teamspace was deleted, or null.

• created_by uuid

  ID of the user who created the teamspace.

• updated_by uuid

  ID of the user who last updated the teamspace.

Response200

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created_at": "2023-11-19T11:56:55.176802Z",
  "updated_at": "2023-11-19T11:56:55.176809Z",
  "deleted_at": null,
  "name": "Engineering Team",
  "description_json": {},
  "description_html": "<p>Engineering team workspace</p>",
  "description_stripped": "Engineering team workspace",
  "description_binary": null,
  "logo_props": {
    "in_use": "emoji",
    "emoji": {
      "value": "1f680"
    }
  },
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": null,
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}