# Get

`GET /workspaces/:workspace`

Get a specific workspace by domain

**Required Scopes:** `WORKSPACE`

## URL Parameters

```typescript
interface URLParameters {
  /** The human-readable ID of the workspace */
  workspace: string; // Example: "my-company"
}
```

## Response Body

```typescript
interface ResponseBody {
  /** API endpoint to GET this object */
  url?: string;
  /** Web URL to view this object in Buddy.works */
  html_url?: string;
  /** The ID of the workspace */
  id?: number;
  /** The name of the workspace */
  name?: string;
  /** The human-readable ID of the workspace. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end). */
  domain?: string;
  /** The ID of the workspace owner */
  owner_id?: number;
  /** Whether the workspace is frozen */
  frozen?: boolean;
  /** The date and time when the workspace was created */
  create_date?: string;
  /** Default pipeline resource allocation for the workspace */
  default_pipeline_resource?: "DEFAULT" | "NANO" | "SMALL" | "MEDIUM" | "LARGE" | "XLARGE" | "CUSTOM" | "X2LARGE";
  /** Whether Single Sign-On (SSO) is enabled for the workspace */
  sso_enabled?: boolean;
  /** Whether public pipelines are disabled in the workspace */
  public_pipelines_disabled?: boolean;
}
```

## Response Example

**Status:** `200 OK`

```json
{
  "url": "https://api.buddy.works/workspaces/my-company",
  "html_url": "https://app.buddy.works/my-company",
  "id": 1,
  "name": "My Company",
  "domain": "my-company",
  "owner_id": 123,
  "frozen": false,
  "create_date": "2023-01-15T10:30:00.123456789Z",
  "default_pipeline_resource": "MEDIUM",
  "sso_enabled": true,
  "public_pipelines_disabled": false
}
```

---
Original source: https://buddy.works/docs/api/platform/workspaces/get