Create workspace
Create a new workspace in the current organization.
Request schema
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
name
stringrequired
The name of the workspace. Must be unique within the organization.
example:
notification_emails
array
The list of emails that will receive alerts from the workspace.
example:
type:
return_workspace_api_key
boolean
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:
Http + 1.1
POST
https://app.getcensus.com/api/v1/workspaces
POST /api/v1/workspaces HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Content-Type: application/json Host: app.getcensus.com Content-Length: 136 { "name": "My Workspace", "notification_emails": [ "notifications@mycompany.slack.com" ], "return_workspace_api_key": true }
Responses
201
Successfully created a new workspace.
201
status
stringrequired
The outcome of the creation request
enum:
data
objectrequired
id
integer
The id of the retrieved workspace.
example:
name
string
The name of the workspace. Must be unique within the organization.
example:
organization_id
integer
The id of the organization the workspace belongs to.
example:
created_at
string
The timestamp of when the workspace was created.
format:
example:
notification_emails
array
The list of emails that will receive alerts from the workspace.
example:
type:
api_key
string
The API key of the workspace.
example:
{ "status": "success", "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" } }