---
title: "Get workspace data"
method: GET
path: "/api/v1/workspaces"
tags: ["workspace"]
---

# Get workspace data

`GET /api/v1/workspaces`

Retrieve the current workspace's metadata, including users and invites.

    This endpoint returns:
    - Workspace name, settings, and configuration
    - List of user IDs in the workspace
    - Workspace invite information

    **Use cases:**
    - Displaying workspace details in dashboards
    - Fetching workspace data for integrations
    - Validating workspace context for user actions

## Response `200`

This response returns the data for the current workspace.

- object — This response returns the data for the current workspace.
  - `id` string, required
  - `users` string[], required
  - `roles` object, required
  - `name` string, required
  - `created` string, date-time, required
  - `picture` string, uri, required
  - `subscriptionStatus` 'payment_failed' | 'active' | 'canceled' | 'trialing' | 'overdue', required
  - `creator` string, required
  - `updater` string, required
  - `apiVersion` string
  - `willCancelAt` string, date-time, required
  - `blockedUsers` string[]
  - `type` unknown
  - `preferences` object
    - `disableAi` boolean
    - `enableAutoSceneNaming` boolean
    - `disableEmailEditing` boolean
    - `disableSceneSharing` boolean
    - `userApiKeysEnabled` boolean
  - `flags` number
  - `isDeleted` boolean
  - `deletedAt` number

## Other responses

- `401` — This response indicates that the client must authenticate to access the requested resource.
- `403` — This response indicates that the client does not have permission to access the requested resource.

---

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