Create workspace onboard

POST/workspaces/onboard

Request body

application/json

namestringrequired

min length 1

slugstringrequired

min length 1

keystring

Responses

201Workspace onboarded with default team and admin token

workspaceobjectrequired

Show properties

idstringrequired

namestringrequired

slugstringrequired

keystring | nullrequired

ownerIdstringrequired

createdAtstringrequired

updatedAtstringrequired

teamobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

keystringrequired

namestringrequired

ownerIdstringrequired

isDefaultbooleanrequired

isPublicbooleanrequired

parentAutoClosebooleanrequired

triageAssigneeIdstring | nullrequired

defaultTemplateIdstring | nullrequired

subIssueAutoClosebooleanrequired

createdAtstringrequired

updatedAtstringrequired

tokenstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Bodyapplication/json

namestring*slugstring*keystring

Request

curl -X POST "/workspaces/onboard" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "slug": "string",
  "key": "string"
}'

const response = await fetch("/workspaces/onboard", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"key\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/onboard",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"key\": \"string\"\n}",
)

Response

{
  "workspace": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "key": "string",
    "ownerId": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "team": {
    "id": "string",
    "organizationId": "string",
    "key": "string",
    "name": "string",
    "ownerId": "string",
    "isDefault": true,
    "isPublic": true,
    "parentAutoClose": true,
    "triageAssigneeId": "string",
    "defaultTemplateId": "string",
    "subIssueAutoClose": true,
    "createdAt": "string",
    "updatedAt": "string"
  },
  "token": "string"
}