List Client Sessions
Get all client sessions
Returns a list of all client sessions.
Request
List all client sessions or filter the list of client sessions by including the corresponding filter parameters in the request body.
Request Body Parameters
client_session_id
String Optional
ID of the client session that you want to retrieve
user_identifier_key
String Optional
Your own internal user ID for the user by which to filter client sessions
connect_webview_id
String Optional
ID of the Connect Webview for which you want to retrieve client sessions
without_user_identifier_key
Boolean Optional
Indicates whether to retrieve only client sessions without associated user identifier keys
Sample Request
Response
Returns a client_sessions
array, in which each returned client session (client_session
) contains the following properties:
workspace_id
ID of the workspace that contains the client session
token
Client session token associated with the client session
user_identifier_key
Your own internal user ID for the user
created_at
Date and time at which the client session was created
client_session_id
ID of the client session
user_identity_ids
Array of user identity IDs on behalf of which which the client session may act
connect_webview_ids
Array of Connect Webview IDs associated with the client session
device_count
Number of devices to which the client session grants access
connected_account_ids
Array of connected account IDs associated with this client session
This response also includes a Boolean ok
status indicator.
Sample Response
Last updated