Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Sessions

List all sessions

Returns a list of sessions matching the provided criteria. The sessions are returned sorted by creation date, with the newest sessions appearing first.

Note: This endpoint does not return all sessions that have ever existed. Old and inactive sessions are periodically cleaned up and will not be included in the results.

Deprecation Notice (2024-01-01): All parameters were initially considered optional, however moving forward at least one of client_id or user_id parameters should be provided.

get/sessions

Query parameters

client_idstring

List sessions for the given client

user_idstring

List sessions for the given user

status'abandoned' | 'active' | 'ended' | 'expired' | 'removed' | 'replaced' | 'revoked'

Filter sessions by the provided status

paginatedboolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offsetinteger

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Response

Success

object'session' required

String representing the object's type. Objects of the same type share the same value.

idstring required
user_idstring required
client_idstring required
actorobject nullable
status'active' | 'revoked' | 'ended' | 'expired' | 'removed' | 'abandoned' | 'replaced' | 'pending' required
last_active_organization_idstring nullable
last_active_atinteger required
expire_atinteger required

Unix timestamp of expiration.

abandon_atinteger required

Unix timestamp of abandonment.

updated_atinteger required

Unix timestamp of last update.

created_atinteger required

Unix timestamp of creation.