Skip to main content
When you first sign up for Plane, we create a Workspace for you and your company. All workers, payments, and other entities are associated with your Workspace. Most endpoints will not require that you provide a Workspace ID because it can be inferred from the API key you are using to authenticate your request. A partner workspace’s API keys also manage the workspaces the partner created for its clients, naming the workspace they act on with the Plane-Workspace header on any other endpoint.

Attributes

string
Unique identifier for the workspace, e.g. wsp_4kW3GnQCo1CQ49.
string
The name of your workspace, e.g. Apple. We’ll generally refer to your company by the name of your workspace, unless your legal business name is needed, in which case we will use the Entity name.
string
The lifecycle status of the workspace. Workspaces are active from creation. Possible values: active (operating normally), suspended (temporarily paused by Plane; reversible), or closed (permanently closed; the workspace and its history remain readable).
string
The customer billed for this workspace. For a partner-created workspace this is the partner’s customer until the workspace becomes a standalone customer.
string
Time at which the workspace was created.
string
Time at which the workspace was last updated.