Seam Docs
Searchβ¦
π
Welcome!
π²
Quickstart
Get API Key
Install Client Library
Connect a Device
Your First Device API Call
π
Core Concepts
Overview
Workspaces
Connect Views
Device Capabilities
Action Attempts
Webhooks
π
Device Guides
Get started with August Locks
Get started with NoiseAware Sensors
Get started with Schlage Connect Locks
Get started with SmartThings Hubs + Smart Locks
Sandbox & Sample Data
API Endpoints
Overview
Workspaces
Devices
Connect Webviews
Connected Accounts
Action Attempt
Events
Reference
Glossary
Legacy System
Seam Hub API for ZWave
For Device Manufacturers
Creating a Seam-Compatible Intercom API
Powered By
GitBook
Workspaces
A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and connect webviews.
The Workspace Object
workspace_id
uuid
ID of the Workspace
name
string
Name of the Workspace
is_sandbox
boolean
Whether this workspace is a Test Sandbox environment
Get Workspace
get
https://connect.getseam.com
/workspaces/get
Get a Workspace
Python
Javascript
CURL
Ruby
from
seamapi
import
Seam
β
seam
=
Seam
()
workspace
=
seam
.
workspaces
.
get
()
β
print
(
workspace
)
# Workspace(
# workspace_id='123e4567-e89b-12d3-a456-426614174000',
# name='Sandbox',
# is_sandbox=True
# )
import
Seam
from
"seamapi"
β
const
seam
=
Seam
()
const
workspaceId
=
"123e4567-e89b-12d3-a456-426614174000"
const
workspace
=
await
seam
.
workspaces
.
get
(
workspaceId
)
β
console
.
log
(
workspace
)
/*
{
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Workspace 1",
"is_sandbox": false
}
*/
// Coming Soon!
require
"seamapi"
β
seam
=
Seam
::
Client
.
new
(
api_key
:
"MY_API_KEY"
)
β
workspace
=
seam
.
workspaces
.
get
β
puts workspace
# <Seam::Workspace:0x0070328
# workspace_id="123e4567-e89b-12d3-a456-426614174000"
# name="MySandbox"
# connect_partner_name="Partner Sandbox"
# is_sandbox=true>
β
Reset Your Workspace Sandbox
This method is only available on Sandbox Workspaces
post
https://connect.getseam.com
/workspaces/reset_sandbox
Reset the sandbox on this workspace
Python
Javascript
Ruby
from
seamapi
import
Seam
β
seam
=
Seam
()
seam
.
workspaces
.
reset_sandbox
()
import
Seam
from
"seamapi"
β
const
seam
=
Seam
()
const
workspaceId
=
"123e4567-e89b-12d3-a456-426614174000"
await
seam
.
workspaces
.
reset_sandbox
(
workspaceId
)
require
"seamapi"
β
seam
=
Seam
::
Client
.
new
(
api_key
:
"MY_API_KEY"
)
β
seam
.
workspaces
.
reset_sandbox
API Endpoints - Previous
Overview
Next - API Endpoints
Devices
Last modified
1mo ago
Copy link
Outline
The Workspace Object
Get Workspace
get
Get a Workspace
Reset Your Workspace Sandbox
post
Reset the sandbox on this workspace