Workspaces

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

Reset Your Workspace Sandbox

post

Reset the sandbox on this workspace