---
title: "GET /v1/workspaces/by-slug/{workspaceSlug}"
method: GET
path: "/v1/workspaces/by-slug/{workspaceSlug}"
tags: ["Workspaces"]
---

# GET /v1/workspaces/by-slug/{workspaceSlug}

`GET /v1/workspaces/by-slug/{workspaceSlug}`

## Request

- Base URL: `https://api.atlas-compiler.com`
- URL: `https://api.atlas-compiler.com/v1/workspaces/by-slug/{workspaceSlug}`
- Auth: HTTP bearer

## Path parameters

- `workspaceSlug` string, required

## Response `200`

Success

- object
  - `contractVersion` 'phase1-workspace-v1', required
  - `workspace` object, required
    - `createdAt` string, date-time, required
    - `defaultProject` object, nullable, required
      - `id` string, required
      - `name` string, required
      - `slug` string, required
    - `id` string, required
    - `isPrimary` boolean, required
    - `name` string, required
    - `planSnapshot` object, required
      - `features` object[], required
        - `enabled` boolean, required
        - `key` string, required
      - `id` string, required
      - `limits` object[], required
        - `key` string, required
        - `unit` string, required
        - `value` integer, nullable, required
      - `plan` object, required
        - `code` string, required
        - `version` integer, required
      - `schemaVersion` 1, required
      - `snapshotVersion` integer, required
    - `role` 'owner' | 'admin' | 'developer' | 'viewer', required
    - `slug` string, required
    - `status` 'active' | 'suspended' | 'deleting', required
    - `updatedAt` string, date-time, required
    - `version` integer, required

## Other responses

- `400`: RFC 9457 problem.
- `401`: RFC 9457 problem.
- `403`: RFC 9457 problem.
- `404`: RFC 9457 problem.
- `409`: RFC 9457 problem.
- `500`: RFC 9457 problem.
- `503`: RFC 9457 problem.

---

[API](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api.md) · [All operations](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/atlas-compiler/apis/atlas-backend-api/revisions/a43b60619cdf?raw)