List Client Sessions

• Request Parameters

• Response

• Examples

Returns a list of all client sessions.

JavaScript

Returns a list of all client sessions for a specific client session ID.

Code:

await seam.clientSessions.list({
  client_session_id: "a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc",
});

Output:

[
  {
    "client_session_id": "a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc",
    "connect_webview_ids": ["e0f522d4-a7b6-4f65-ba90-11cde67a893a"],
    "connected_account_ids": ["c35ecf64-474a-466a-95a6-7b35cb4c8bb4"],
    "created_at": "2025-06-15T16:54:17.946309Z",
    "customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
    "device_count": 1,
    "expires_at": "2025-06-18T06:10:42.000Z",
    "token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
    "user_identifier_key": "jane_doe",
    "user_identity_id": "b4ce8233-3b35-4d2d-82ec-d48513684f0a",
    "workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
  }
]

cURL

Python

Ruby

PHP

Seam CLI

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

client_session_id String

ID of the client session that you want to retrieve.

---

connect_webview_id String

ID of the Connect Webview for which you want to retrieve client sessions.

---

user_identifier_key String

Your user ID for the user by which you want to filter client sessions.

---

user_identity_id String

ID of the user identity for which you want to retrieve client sessions.

---

without_user_identifier_key Boolean

Indicates whether to retrieve only client sessions without associated user identifier keys.

---

Response

Returns: Array of client_sessions

JSON

{
  "client_session_id": "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
  "connect_webview_ids": ["550e8400-e29b-41d4-a716-446655440000"],
  "connected_account_ids": ["f47ac10b-58cc-4372-a567-0e02b2c3d479"],
  "created_at": "2025-06-15T16:54:17.946309Z",
  "customer_id": "77eccc4e-c8bc-4c7d-b83c-cb853ed3bade",
  "device_count": 1,
  "expires_at": "2025-06-17T16:54:17.946309Z",
  "token": "seam_cst1891oqCmB_6dBwV8PJ2Fsoe9dWYVyMfVHq",
  "user_identifier_key": "user_id_1",
  "user_identity_id": "a6e93f84-565e-47d7-8908-1ca71ada373c",
  "user_identity_ids": ["a6e93f84-565e-47d7-8908-1ca71ada373c"],
  "workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
}

---

Examples

List client sessions for a user identifier key

Returns a list of all client sessions for a specific user identifier key.

JavaScript

Code:

await seam.clientSessions.list({ user_identifier_key: "jane_doe" });

Output:

[
  {
    "client_session_id": "a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc",
    "connect_webview_ids": ["e0f522d4-a7b6-4f65-ba90-11cde67a893a"],
    "connected_account_ids": ["c35ecf64-474a-466a-95a6-7b35cb4c8bb4"],
    "created_at": "2025-06-15T16:54:17.946309Z",
    "customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
    "device_count": 1,
    "expires_at": "2025-06-18T06:10:42.000Z",
    "token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
    "user_identifier_key": "jane_doe",
    "user_identity_id": "b4ce8233-3b35-4d2d-82ec-d48513684f0a",
    "workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
  }
]

cURL

Python

Ruby

PHP

Seam CLI

---

List client sessions for a Connect Webview ID

Returns a list of all client sessions for a specific Connect Webview ID.

JavaScript

Code:

await seam.clientSessions.list({
  connect_webview_id: "e0f522d4-a7b6-4f65-ba90-11cde67a893a",
});

Output:

[
  {
    "client_session_id": "a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc",
    "connect_webview_ids": ["e0f522d4-a7b6-4f65-ba90-11cde67a893a"],
    "connected_account_ids": ["c35ecf64-474a-466a-95a6-7b35cb4c8bb4"],
    "created_at": "2025-06-15T16:54:17.946309Z",
    "customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
    "device_count": 1,
    "expires_at": "2025-06-18T06:10:42.000Z",
    "token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
    "user_identifier_key": "jane_doe",
    "user_identity_id": "b4ce8233-3b35-4d2d-82ec-d48513684f0a",
    "workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
  }
]

cURL

Python

Ruby

PHP

Seam CLI

---

List client sessions for a user identity ID

Returns a list of all client sessions for a specific user identity ID.

JavaScript

Code:

await seam.clientSessions.list({
  user_identity_id: "b4ce8233-3b35-4d2d-82ec-d48513684f0a",
});

Output:

[
  {
    "client_session_id": "a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc",
    "connect_webview_ids": ["e0f522d4-a7b6-4f65-ba90-11cde67a893a"],
    "connected_account_ids": ["c35ecf64-474a-466a-95a6-7b35cb4c8bb4"],
    "created_at": "2025-06-15T16:54:17.946309Z",
    "customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
    "device_count": 1,
    "expires_at": "2025-06-18T06:10:42.000Z",
    "token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
    "user_identifier_key": "jane_doe",
    "user_identity_id": "b4ce8233-3b35-4d2d-82ec-d48513684f0a",
    "workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
  }
]

cURL

Python

Ruby

PHP

Seam CLI

---

List client sessions without a user identifier key

Returns a list of all client sessions without a user identifier key.

JavaScript

Code:

await seam.clientSessions.list({ without_user_identifier_key: true });

Output:

[
  {
    "client_session_id": "a083ce0f-8b03-4081-ac9a-1ad2ce6aaabc",
    "connect_webview_ids": ["e0f522d4-a7b6-4f65-ba90-11cde67a893a"],
    "connected_account_ids": ["c35ecf64-474a-466a-95a6-7b35cb4c8bb4"],
    "created_at": "2025-06-15T16:54:17.946309Z",
    "customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
    "device_count": 1,
    "expires_at": "2025-06-18T06:10:42.000Z",
    "token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
    "user_identifier_key": null,
    "user_identity_id": "b4ce8233-3b35-4d2d-82ec-d48513684f0a",
    "workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
  }
]

cURL

Python

Ruby

PHP

Seam CLI