---
title: "Get a Workspace"
method: POST
path: "/workspaces/get"
tags: ["/workspaces"]
---

# Get a Workspace

`POST /workspaces/get`

Returns the [workspace](/core-concepts/workspaces) associated with the authentication value.

## Response `200`

OK

- object
  - `workspace` Workspace, required — Represents a Seam [workspace](/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. See the [workspace object](/api/workspaces/object).
    - `company_name` string, required — Company name associated with the [workspace](/core-concepts/workspaces).
    - `connect_partner_name` string, nullable, required — Deprecated. Use `company_name` instead.
    - `connect_webview_customization` object, required
      - `inviter_logo_url` string — URL of the inviter logo for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
      - `logo_shape` 'circle' | 'square' — Logo shape for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
      - `primary_button_color` string — Primary button color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
      - `primary_button_text_color` string — Primary button text color for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
      - `success_message` string — Success message for [Connect Webviews](/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
    - `is_publishable_key_auth_enabled` boolean, required — Indicates whether publishable key authentication is enabled for this workspace.
    - `is_sandbox` boolean, required — Indicates whether the workspace is a [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces).
    - `is_suspended` boolean, required — Indicates whether the [sandbox workspace](/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
    - `name` string, required — Name of the [workspace](/core-concepts/workspaces).
    - `organization_id` string, uuid, nullable, required — ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.
    - `publishable_key` string — Publishable key for the [workspace](/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
    - `workspace_id` string, uuid, required — ID of the workspace.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

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