Spaces API: Create

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/spaces/create
Handler	OperatelyWeb.Api.Spaces.Create

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
name	string	Yes	No	-
mission	string	Yes	No	-
company_permissions	access_options_int enum (0, 10, 40, 70, 100)	Yes	No	-
public_permissions	access_options_int enum (0, 10, 40, 70, 100)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
space	space object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/spaces/create" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"company_permissions":"<access_options_int>", "mission":"value", "name":"value", "public_permissions":"<access_options_int>"}'

Response Example#

{
  "space": {
    "__typename": "value",
    "access_levels": "<access_levels>",
    "color": "value",
    "icon": "value",
    "id": "value",
    "is_company_space": true,
    "is_member": true,
    "members": [
      "<person>"
    ],
    "mission": "value",
    "name": "value",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<space_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "private_space": true,
    "task_statuses": [
      "<task_status>"
    ],
    "tasks_kanban_state": "value",
    "url": "value"
  }
}