Skip to main content
POST
/
api
/
workspaces
cURL
curl --request POST \
  --url https://recoup-api.vercel.app/api/workspaces \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "workspace": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isWorkspace": true
  }
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Body

application/json

Workspace creation parameters

​
name
string

Name of the workspace (defaults to "Untitled")

​
account_id
string<uuid>

UUID of the account to create the workspace for. Only applicable for organization API keys - org keys can specify an account_id for any account within their organization. If not provided, the workspace is created for the API key's own account.

​
organization_id
string<uuid>

Organization to link the workspace to

Response

Workspace created successfully

​
workspace
object
required