Seam Docs
Search…
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
1
from seamapi import Seam
2
​
3
seam = Seam()
4
workspace = seam.workspaces.get()
5
​
6
print(workspace)
7
# Workspace(
8
# workspace_id='123e4567-e89b-12d3-a456-426614174000',
9
# name='Sandbox',
10
# is_sandbox=True
11
# )
Copied!
1
import Seam from "seamapi"
2
​
3
const seam = Seam()
4
const workspaceId = "123e4567-e89b-12d3-a456-426614174000"
5
const workspace = await seam.workspaces.get(workspaceId)
6
​
7
console.log(workspace)
8
/*
9
{
10
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
11
"name": "Workspace 1",
12
"is_sandbox": false
13
}
14
*/
Copied!
1
// Coming Soon!
Copied!

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
1
from seamapi import Seam
2
​
3
seam = Seam()
4
seam.workspaces.reset_sandbox()
Copied!
1
import Seam from "seamapi"
2
​
3
const seam = Seam()
4
const workspaceId = "123e4567-e89b-12d3-a456-426614174000"
5
await seam.workspaces.reset_sandbox(workspaceId)
Copied!