Skip to main content
POST
/
workspaces
/
{workspace_id}
/
clone
Clone workspace
curl --request POST \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id}/clone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_workspace_name": "<string>",
  "application_variables": [
    {
      "key": "<string>",
      "value": "<unknown>"
    }
  ],
  "return_workspace_api_key": true
}
'
{
  "status_endpoint": "https://app.getcensus.com/api/v1/workspaces/1123/clone_status",
  "data": {
    "id": 123,
    "name": "My Workspace",
    "organization_id": 1,
    "created_at": "2023-09-05T19:42:42.672Z",
    "notification_emails": [
      "[email protected]"
    ],
    "api_key": "YourAPIKeyHere"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authorization using your Personal Access Token. Generate a new PAT on your user settings page.

Path Parameters

​
workspace_id
integer
required

ID of the workspace

Body

application/json
​
new_workspace_name
string
required

The name for the new cloned workspace.

​
application_variables
object[]

Optional. An array of key-value pairs representing workspace variables for the new workspace. All variable keys used in the base workspace must be provided for the cloned workspace.

​
return_workspace_api_key
boolean
default:false

Whether or not a successful result should include the api_key field in the response. This workspace api_key is used to interact with the Workspace APIs.

Example:

true

Response

Successfully issued a clone of a workspace. The clone is in progress. To find the status of the clone use the status_endpoint returned.

​
status_endpoint
string

The url of the new workspace's clone status.

Example:

"https://app.getcensus.com/api/v1/workspaces/1123/clone_status"

​
data
object