Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Workspace API

Get a specific workspace by domain

get/workspaces/{workspace_domain}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idinteger

The ID of the workspace

namestring

The name of the workspace

domainstring

The human-readable ID of the workspace. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).

owner_idinteger

The ID of the workspace owner

frozenboolean

Whether the workspace is frozen

create_datestring date-time

The date and time when the workspace was created

default_pipeline_resource'DEFAULT' | 'NANO' | 'SMALL' | 'MEDIUM' | 'LARGE' | 'XLARGE' | 'CUSTOM' | 'X2LARGE'

Default pipeline resource allocation for the workspace

sso_enabledboolean

Whether Single Sign-On (SSO) is enabled for the workspace

public_pipelines_disabledboolean

Whether public pipelines are disabled in the workspace