Skip to content

overview.md

Latest commit

 

History

History
93 lines (55 loc) · 1.97 KB

overview.md

File metadata and controls

93 lines (55 loc) · 1.97 KB
title Overview
description Plane Teamspace API overview. Learn about endpoints, request/response format, and how to work with teamspace via REST API.
keywords plane api, teamspace, team management, team collaboration, workspace teams, rest api, api integration

Overview

Teamspaces allow you to organize teams, projects, and members within a workspace, providing a way to group related work and manage access at a team level.

Learn more about 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

    Stripped version of the HTML description.

  • description_binary string

    Binary representation of the description.

  • logo_props object

    Logo properties for the teamspace.

  • lead uuid

    ID of the user who leads the teamspace.

  • 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.

  • created_by uuid

    ID of the user who created the teamspace.

  • updated_by uuid

    ID of the user who last updated the teamspace.

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