Get a Workspace

await seam.workspaces.get(); /* { "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": true, "is_suspended": false, "is_publishable_key_auth_enabled": true, "publishable_key": "seam_pk1fGd41X_zKs0ZELRTEc8nWxiBsEXAMPLE", "name": "My Sandbox Workspace", "workspace_id": "6a0b6282-6a98-4fef-811e-0904c485ac7a" } */

{ "workspace": { "company_name": "<string>", "connect_partner_name": "<string>", "connect_webview_customization": { "inviter_logo_url": "<string>", "primary_button_color": "<string>", "primary_button_text_color": "<string>", "success_message": "<string>" }, "is_publishable_key_auth_enabled": true, "is_sandbox": true, "is_suspended": true, "name": "<string>", "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "publishable_key": "<string>" } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

workspace

object

required

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. See the workspace object.

Show child attributes

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Get a Workspace

Authorizations

Response