The API has the ability to create a workspace from an existing template. It does not have the ability to create a workspace template or clone an existing workspace into a workspace template.

Get a list of workspace templates

User templates must be created through the UI. There are also system templates that have a built-in identifier: “wiki”, “blog”, “db”, “forum”, “help_desk”, “pm”, and “intranet”.

The list of available templates, including system templates, may be retrieved through the API. The API will return a list of templates, each having a unique ID. This ID is will be used to create a workspace from this template.

GET /v1/workspaces/templates

{
  "totalCount": 0,
  "links": {
    "prev": "",
    "next": "",
    "first": "",
    "last": ""
  },
  "items": [
    {
      "id": "",
      "resourceUri": "",
      "resourceType": "v1:Workspace",
      ...
    }
  ]
}

Use the workspace template to create a new workspace

Create a workspace with the following Json. The template ID will be specified in the workspaceType field. This will be either the ID of a user template or one of the built-in system template IDs.

{
  "workspaceName": "",
  "urlShortName": "",
  "description": "",
  "workspaceType": "",
  "customFields": [
    {
      "fieldApiId": "",
      "value": ""
    }
  ]
}