Clone workspace

POST

workspaces

{workspace_id}

clone

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": "<any>"
    }
  ],
  "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": [
      "notifications@mycompany.slack.com"
    ],
    "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

202

application/json

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

data.id

integer

The id of the retrieved workspace.

Example:

123

data.name

string

The name of the workspace. Must be unique within the organization.

Example:

"My Workspace"

data.organization_id

integer

The id of the organization the workspace belongs to.

Example:

1

data.created_at

string

The timestamp of when the workspace was created.

Example:

"2023-09-05T19:42:42.672Z"

data.notification_emails

string[]

The list of emails that will receive alerts from the workspace.

Example:

["notifications@mycompany.slack.com"]

data.api_key

string

The API key of the workspace.

Example:

"YourAPIKeyHere"

Was this page helpful?

Raise issue

Delete workspace Fetch clone status

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": "<any>"
    }
  ],
  "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": [
      "notifications@mycompany.slack.com"
    ],
    "api_key": "YourAPIKeyHere"
  }
}

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Body

Response