Skip to main content

​
The workspace Object

Represents a Seam workspace. 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 is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a production workspace. 
{
  "company_name": "Acme",
  "connect_partner_name": "Acme",
  "connect_webview_customization": {
    "inviter_logo_url": "https://connect.getseam.com/internal/images/view?image_id=1de135fa-f0c2-4e57-90d0-6b9a7d090a0c",
    "logo_shape": "circle",
    "primary_button_color": "#232426",
    "primary_button_text_color": "#FFFDE7",
    "success_message": "Your account has been successfully connected to Acme!"
  },
  "is_sandbox": false,
  "is_suspended": false,
  "is_publishable_key_auth_enabled": true,
  "publishable_key": "seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE",
  "name": "My Production Workspace",
  "workspace_id": "6a0b6282-6a98-4fef-811e-0904c485ac7a"
}

​
Properties

​
company_name
String
Company name associated with the workspace.
​
connect_partner_name
String
deprecated
The connect partner name.
​
connect_webview_customization
Object
The connect webview customization.
​
is_publishable_key_auth_enabled
Boolean
Indicates whether publishable key authentication is enabled for this workspace.
​
is_sandbox
Boolean
Indicates whether the workspace is a sandbox workspace.
​
is_suspended
Boolean
Indicates whether the sandbox workspace is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
​
name
String
Name of the workspace.
​
publishable_key
String
Publishable key for the workspace. This key is used to identify the workspace in client-side applications.
​
workspace_id
String (UUID)
ID of the workspace.