Skip to main content
POST
/
organizations
/
{organizationId}
/
workspaces
Create Workspace
curl --request POST \
  --url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "workspace 1",
  "description": "workspace description"
}
'
{
  "id": "8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea",
  "name": "workspace 1",
  "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5",
  "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef",
  "description": "workspace description",
  "createdAt": null,
  "defaultWorkspace": false
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
organizationId
string
required

Organization ID

Body

application/json

Create Workspace

​
name
string

The name of the workspace

​
description
string

Descriptive text about the workspace

Response

200 - application/json

Successful operation

​
id
string<uuid>

The unique identifier of the workspace

​
name
string

The name of the workspace

​
createdBy
string<uuid>

The unique identifier of the user who created the workspace

​
organizationId
string<uuid>

The unique identifier of the organization to which the workspace belongs

​
description
string

Descriptive text about the workspace

​
createdAt
string

The date and time the workspace was created

​
defaultWorkspace
boolean

Whether the workspace is the default workspace for the organization.

This is a backward compatibility field in order to create projects in the default workspace if the workspace is not specified.