---
title: "Get workspace details"
method: GET
path: "/workspaces/{workspace_id}"
tags: ["Workspaces"]
---

# Get workspace details

`GET /workspaces/{workspace_id}`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Fetch additional details about workspace

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

## Query parameters

- `fields` string: Fields to be returned in a comma-separated format may include id, name, created_at, updated_at.

## Response `200`

Get details of a workspace

- WorkspacesSchema
  - `workspaces` WorkspaceSchema[], required
    - `id` integer, nullable
    - `name` string, nullable: Name of the workspace
    - `created_at` string, date-time, nullable: Time when workspace was created
    - `updated_at` string, date-time, nullable: Time when workspace was last updated
    - `status` 'INITED' | 'ACTIVE' | 'SUSPENDED' | 'DELETED' | 'TO_BE_DELETED' | 'UNVERIFIED' | 'ARCHIVED', nullable: Status of the workspace
    - `acc_image` string, nullable: Workspace image URL
    - `date_format` string, nullable: Workspace date region
    - `total_users` integer, nullable: Total number of users in the workspace
    - `path` string, nullable: Workspace path
    - `url` string, nullable: Workspace url
    - `last_accessed` string, date-time, nullable: Time when workspace was last accessed
    - `workspace_metadata` object, nullable: Workspace metadata
    - `subscription` object, nullable: External subscription data for the workspace
    - `subscription_status` string, nullable: Status of the workspace subscription
    - `deletion_scheduled_at` string, date-time, nullable: Scheduled deletion date, present only when marked for deletion
    - `user_access_suspended` boolean, nullable: Whether user access to this workspace is currently suspended (background activity may still run; only member-facing requests are blocked)
    - `download_file_types` string[], nullable: Download formats this workspace's data backend can produce. Parquet is DuckDB-only, so the UI must offer only what this lists.
    - `projects` object[], nullable: Projects in the workspace the user can access
  - `limit` integer
  - `offset` integer
  - `next` string, required

## Other responses

- `304`: Not Modified
- `400`: Bad Request
- `401`: Authorization error

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)