List Workspaces

• Request Parameters

• Response

Returns a list of workspaces associated with the authentication value.

JavaScript

Returns a list of workspaces associated with the authentication value.

Code:

await seam.workspaces.list();

Output:

[
  {
    "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,
    "name": "My Sandbox Workspace",
    "workspace_id": "6a0b6282-6a98-4fef-811e-0904c485ac7a"
  }
]

cURL

Returns a list of workspaces associated with the authentication value.

Code:

curl --include --request POST "https://connect.getseam.com/workspaces/list" \
  --header "Authorization: Bearer $SEAM_API_KEY"

Output:

{
  "workspaces": [
    {
      "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,
      "name": "My Sandbox Workspace",
      "workspace_id": "6a0b6282-6a98-4fef-811e-0904c485ac7a"
    }
  ]
}

Python

Returns a list of workspaces associated with the authentication value.

Code:

seam.workspaces.list()

Output:

[
    Workspace(
        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,
        name="My Sandbox Workspace",
        workspace_id="6a0b6282-6a98-4fef-811e-0904c485ac7a",
    )
]

Ruby

Returns a list of workspaces associated with the authentication value.

Code:

seam.workspaces.list()

Output:

[
  {
    "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,
    "name" => "My Sandbox Workspace",
    "workspace_id" => "6a0b6282-6a98-4fef-811e-0904c485ac7a",
  },
]

PHP

Returns a list of workspaces associated with the authentication value.

Code:

$seam->workspaces->list();

Output:

[
    [
        "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,
        "name" => "My Sandbox Workspace",
        "workspace_id" => "6a0b6282-6a98-4fef-811e-0904c485ac7a",
    ],
];

Seam CLI

Returns a list of workspaces associated with the authentication value.

Code:

seam workspaces list

Output:

[
  {
    "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,
    "name": "My Sandbox Workspace",
    "workspace_id": "6a0b6282-6a98-4fef-811e-0904c485ac7a"
  }
]

Authentication Methods

• API key

• Client session token

• Personal access token Can also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

None

Response

Array of workspaces

JSON

{
  "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": false,
  "is_suspended": false,
  "name": "My Production Workspace",
  "workspace_id": "6a0b6282-6a98-4fef-811e-0904c485ac7a"
}