---
title: "Get workspaces list"
method: GET
path: "/support/workspaces"
tags: ["Workspaces Support"]
---

# Get workspaces list

`GET /support/workspaces`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/support/workspaces`
- 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`

Retrieve a comprehensive list of workspaces along with their details.

## Query parameters

- `limit` integer: Max number of result to return
- `offset` integer: Distance from the beginning of the list of results
- `search` string, nullable
- `sort` string, nullable
- `order` string, nullable
- `billing_source` string, nullable
- `status` 'active' | 'suspended' | 'archived' | 'null', nullable
- `plan_id` integer, nullable

## Response `200`

List of workspaces

- union
  - WorkspaceList
    - `workspaces` union
      - WorkspaceMinSchema[]
        - `id` integer, required: ID of the workspace
        - `name` string, required: Name of the workspace to be created
        - `status` string, required: Status of the workspace
        - `last_updated_at` string, date-time, required: Last Updated At of the workspace
      - WorkspaceStdSchema[]
        - `id` integer, required: ID of the workspace
        - `name` string, required: Name of the workspace to be created
        - `status` string, required: Status of the workspace
        - `last_updated_at` string, date-time, required: Last Updated At of the workspace
        - `created_at` string, date-time, required: Created At
        - `total_users` integer, required: Total Users in the workspace
        - `backend_domain_id` integer, nullable: Backend Domain of the workspace
      - WorkspaceFullSchema[]
        - `id` integer, required: ID of the workspace
        - `name` string, required: Name of the workspace to be created
        - `status` string, required: Status of the workspace
        - `last_updated_at` string, date-time, required: Last Updated At of the workspace
        - `created_at` string, date-time, required: Created At
        - `total_users` integer, required: Total Users in the workspace
        - `backend_domain_id` integer, nullable: Backend Domain of the workspace
        - `storage_used_in_bytes` integer, required: Storage Used In Bytes of the workspace
        - `data_domain_host` union: Data Domain Host of the workspace
          - string, ipv4: IPv4 address
          - string, ipv6: IPv6 address
          - string
        - `reports_domain_host` union: Reports Domain Host of the workspace
          - string, ipv4: IPv4 address
          - string, ipv6: IPv6 address
          - string
      - WorkspaceFieldSchema[]
        - `id` integer, nullable: ID of the workspace
        - `name` string, nullable: Name of the workspace to be created
        - `status` string, nullable: Status of the workspace
        - `last_updated_at` string, date-time, nullable: Last Updated At of the resource
        - `created_at` string, date-time, nullable: Created At
        - `total_users` integer, nullable: Total Users in the workspace
        - `backend_domain_id` integer, nullable: Backend Domain of the workspace
        - `storage_used_in_bytes` integer, nullable: Storage Used In Bytes of the workspace
        - `data_domain_host` union: Data Domain Host of the workspace
          - string, ipv4: IPv4 address
          - string, ipv6: IPv6 address
        - `reports_domain_host` union: Reports Domain Host of the workspace
          - string, ipv4: IPv4 address
          - string, ipv6: IPv6 address
    - `offset` integer, nullable
    - `limit` integer, nullable
    - `next` string, nullable: URI for next page of data
  - InstanceList
    - `instance_types` InstanceSchema[], nullable
      - `tag` string, required: Tag of the instance
      - `id` string, required: ID of the instance

## Other responses

- `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/fe078afe239b?raw)