GET /api/users/{userId}/sessions

Retrieve all non-expired sessions for the user, including session metadata and interaction details when available.

Path parameters

  • userId string Required

    The unique identifier of the user.

Responses

  • 200 application/json

    Return a list of non-expired sessions of the user.

    Hide response attribute Show response attribute object
    • sessions array[object] Required
      Hide sessions attributes Show sessions attributes object
      • tenantId string Required

        Maximum length is 21.

      • modelName string Required

        Minimum length is 1, maximum length is 64.

      • id string Required

        Minimum length is 1, maximum length is 128.

      • payload object Required
        Hide payload attributes Show payload attributes object
        • exp number Required
        • iat number Required
        • jti string Required
        • uid string Required
        • kind string("Session") Required
        • loginTs number Required
        • accountId string Required
        • authorizations object Required
          Hide authorizations attribute Show authorizations attribute object
          • * object Additional properties
            Hide * attributes Show * attributes object
            • sid string
            • grantId string
            • persistsLogout boolean
      • expiresAt number Required
      • consumedAt number | null Required
      • lastSubmission object | null Required
        Hide lastSubmission attributes Show lastSubmission attributes object | null
        • interactionEvent string Required

          Values are SignIn, Register, or ForgotPassword.

        • userId string Required
        • verificationRecords array[object] Required
          One of:
        • signInContext object
          Hide signInContext attribute Show signInContext attribute object
          • * string Additional properties
      • clientId string | null Required
      • accountId string | null Required
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

GET /api/users/{userId}/sessions
curl \
 --request GET 'https://[tenant_id].logto.app/api/users/{userId}/sessions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "sessions": [
    {
      "tenantId": "string",
      "modelName": "string",
      "id": "string",
      "payload": {
        "exp": 42.0,
        "iat": 42.0,
        "jti": "string",
        "uid": "string",
        "kind": "string",
        "loginTs": 42.0,
        "accountId": "string",
        "authorizations": {
          "additionalProperty1": {
            "sid": "string",
            "grantId": "string",
            "persistsLogout": true
          },
          "additionalProperty2": {
            "sid": "string",
            "grantId": "string",
            "persistsLogout": true
          }
        }
      },
      "expiresAt": 42.0,
      "consumedAt": 42.0,
      "lastSubmission": {
        "interactionEvent": "SignIn",
        "userId": "string",
        "verificationRecords": [
          {
            "id": "string",
            "type": "string",
            "identifier": {
              "type": "username",
              "value": "string"
            },
            "verified": true
          }
        ],
        "signInContext": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        }
      },
      "clientId": "string",
      "accountId": "string"
    }
  ]
}