Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Create Workspace

Creates a new workspace and returns it.

post/api/v1/workspaces

Request body

namestring nullable

Name of the workspace.

descriptionstring nullable

Description of the workspace.

is_link_sharing_enabledboolean

Whether link sharing is enabled for the workspace.

is_guest_allowedboolean

Whether guests are allowed in the workspace.

domain_namestring nullable

Workspace email domain.

domain_discoveryboolean

Whether users with matching email domains can discover this workspace.

restrict_email_domainsboolean

Whether workspace invites are restricted to workspace domain.

is_trial_pendingboolean

Whether the workspace is waiting for trial confirmation.

Example request

{
  "name": "Design Team",
  "description": "Workspace for design projects.",
  "is_link_sharing_enabled": true,
  "is_guest_allowed": true,
  "domain_name": "example.com",
  "properties": {
    "region": "EU",
    "country": "ES",
    "acquisition_loop_last_show": "2025-02-12",
    "onboarding_filter_id": 1234
  }
}

Response

Successful Response

object required