Get a Client Session
Returns a specified client session.
Returns a specified client session by ID.
Code
await seam.clientSessions.get({
client_session_id: "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
});
Output
{
"client_session_id": "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
"connect_webview_ids": ["dafe6400-7484-4fd1-8c17-1c901b444250"],
"connected_account_ids": ["8062d457-e28e-481f-aecc-509905627511"],
"created_at": "2025-06-15T16:54:17.946309Z",
"customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
"device_count": 1,
"expires_at": "2025-06-19T15:22:40.000Z",
"token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
"user_identifier_key": "jane_doe",
"user_identity_id": "89765fd3-6193-4d63-8605-e77f75356555",
"workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
}
Request Parameters
client_session_id
String
ID of the client session that you want to get.
user_identifier_key
String
User identifier key associated with the client session that you want to get.
Response
{
"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
Get a client session for a user identifier key
Returns a specified client session, using a user identifier key.
Code
await seam.clientSessions.get({ user_identifier_key: "jane_doe" });
Output
{
"client_session_id": "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
"connect_webview_ids": ["dafe6400-7484-4fd1-8c17-1c901b444250"],
"connected_account_ids": ["8062d457-e28e-481f-aecc-509905627511"],
"created_at": "2025-06-15T16:54:17.946309Z",
"customer_id": "e387e15f-be27-47ad-881f-4a6fc5460c57",
"device_count": 1,
"expires_at": "2025-06-19T15:22:40.000Z",
"token": "seam_cst1891oqCmD_6dBwV8PJ2Fsoe9dWYVyMfVHq",
"user_identifier_key": "jane_doe",
"user_identity_id": "89765fd3-6193-4d63-8605-e77f75356555",
"workspace_id": "b887bf84-9849-4454-a562-cf84293d9781"
}
Last updated
Was this helpful?