Get a Client Session

Returns a specified client session.

POST /client_sessions/get

JavaScript

Seam SDK

await seam.clientSessions.get({
  client_session_id: "c2cbd177-1ace-414b-bb1e-9f129e4a05c1",
});

/*
{
  "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"
}
*/

200

{
  "client_session": {
    "client_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connect_webview_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "connected_account_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "device_count": 123,
    "expires_at": "2023-11-07T05:31:56Z",
    "token": "<string>",
    "user_identifier_key": "<string>",
    "user_identity_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_key": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "ok": true
}

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

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

Body

application/json

client_session_id · string<uuid>

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

200

application/json

OK

client_session · object · required

Represents a client session. If you want to restrict your users' access to their own devices, use client sessions.

Show child attributes

ok · boolean · required