POST
/
organizations
/
{organizationId}
/
workspaces
curl --request POST \
  --url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "createdAt": "<string>",
  "defaultWorkspace": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

Body

application/json
​
name
string

The name of the workspace

​
description
string

Descriptive text about the workspace

Response

200 - */*
OK
​
id
string

The unique identifier of the workspace

​
name
string

The name of the workspace

​
createdBy
string

The unique identifier of the user who created the workspace

​
organizationId
string

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.