REresearchanddesire
Lock Sessions

Get active lock session

Changed on

Returns the newest active lock session, including segment history. If multiple active rows exist, reads select the latest createdAt, breaking ties by highest ID; no session is modified or ended. Returns null in the data field if no session is active. By default reads your own session; pass targetUserId to read the active session of a user you have access to — e.g. a keyholder checking the lockee's lock. When the keyholder hid the timer (isTimeDisplayed: false) and the caller is not a keyholder of the session, endDate and duration are null, matching what the lockee sees on the dashboard; they become visible again once the revealTimeBeforeUnlock window starts.

get/lkbx/session/current

Request

  • Base URL
    https://dashboard.researchanddesire.com/api/v1
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code/oauth/authorize
      Token URL/oauth/token
      Scopeslkbx:read

Query parameters

targetUserIdinteger

Read another user's active session instead of your own. The target must be a user you have access to; otherwise the request fails with 403.

Response

Active lock session or null

oktrue required

Changes

  • 682fc4d7f6d5Revision changes
    • breaking

      the response property ///////// became nullable for 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

  • 2411203b3c10Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API