---
title: "Retrieve a workspace by its ID."
method: GET
path: "/workspaces/{workspaceId}"
---

# Retrieve a workspace by its ID.

`GET /workspaces/{workspaceId}`

Retrieve a workspace by its ID.

## Path parameters

- `workspaceId` string, uuid, required

## Response `200`

Response OK.

- Workspace
  - `id` string, uuid, required — The workspace id.
  - `name` string, required — The workspace name.
  - `slug` string, required — The workspace slug.
  - `dateCreated` string, date-time, required — The workspace creation date.
  - `dateUpdated` string, date-time, required — The workspace last updated date.
  - `creatorId` string, uuid, nullable, required — The workspace creator id.
  - `inviteCode` string — The workspace invite code.
  - `wildcardDomains` string[]
  - `projectCount` integer, required — The number of projects in the workspace.
  - `memberCount` integer, required — The number of members in the workspace.
  - `monthlyUsage` object[]
    - `monthYear` string, date
    - `predictionCount` integer
    - `executionTimeMs` integer, nullable
  - `inviteCount` integer, required — The number of invites in the workspace.
  - `periodStartDate` string, date-time, nullable, required — The start date of the current billing period.
  - `periodEndDate` string, date-time, nullable, required — The end date of the current billing period.
  - `samlOnlyAccess` boolean — Whether the workspace only allows SAML authentication.
  - `status` 'active' | 'past_due' | 'unpaid' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'trialing' | 'paused', required

## Other responses

- `default` — Unexpected error.

---

[API](https://skmtc.net/openlayer/apis/openlayer-api.md) · [All operations](https://skmtc.net/openlayer/apis/openlayer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openlayer/openlayer-api/versions/d0e74f00c900/schema)