KEkeycardai
Sessions

List sessions

Changed on

Returns sessions in the specified zone. By default, returns entry sessions (app user sessions with an initiator that are roots or direct children of a root user session). Use include_nested=true to include nested sessions. Can be filtered by session type, status, and user.

get/zones/{zoneId}/sessions

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/sessions
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

Query parameters

session_type'user' | 'application'
active'true'
status'active' | 'expired' | 'revoked'
user_idstring

Filter by user ID

include_nested'true'

Include nested sessions. When false (default), only returns entry sessions (direct children of root user sessions). When true, returns all sessions with an initiator, including nested sessions.

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]

Response

Default Response

Changes

  • 0cfaff865771Revision changes
    • warning

      removed the optional property ////////////// from the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

  • d65d51379d93Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      the //////// response's property pattern ^[a-z0-9]+(?:[-_][a-z0-9]+)*$ was added for the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status