📋 API ReferenceWorkspaces Get Workspace Retrieve the Workspace that is associated with an API Key
Get one workspace connected to account
GET
https://connect.getseam.com/workspaces/get
Retrieve a Workspace using its ID.
200: OK Workspace retrieved
Copy {
"workspace" : {
"workspace_id" : "f97073eb-c003-467a-965b-e6dba3a0131d" ,
"name" : "seam" ,
"connect_partner_name" : "partner_name" ,
"is_sandbox" : true
} ,
"ok" : true
}
Code Example
Python Javascript Ruby
Copy seam . workspaces . get ()
# Workspace(
# workspace_id='123e4567-e89b-12d3-a456-426614174000',
# name='Sandbox',
# is_sandbox=True
# )
Copy await seam . workspaces .get ()
/*
{
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Workspace 1",
"is_sandbox": false
}
*/
Copy seam . workspaces . get
# <Seam::Workspace:0x0070328
# workspace_id="123e4567-e89b-12d3-a456-426614174000"
# name="MySandbox"
# connect_partner_name="Partner Sandbox"
# is_sandbox=true>
Parameters
This method doesn't take any parameters.
Response
This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.
JSON format
JSON
Copy {
"workspace" : {
"workspace_id" : "f97073eb-c003-467a-965b-e6dba3a0131d" ,
"name" : "seam" ,
"connect_partner_name" : "partner_name" ,
"is_sandbox" : true
} ,
"ok" : true
}
Last updated 5 months ago