REresearchanddesire
Lock Sessions

List lock sessions

Changed on

Returns a summary list of all lock sessions you have access to (past and present). Includes sessions owned by linked users — e.g. a lockee you keyhold for — alongside your own; use ownerId to distinguish owners.

get/lkbx/session

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

limitinteger
Example:50

Number of records to return (default 50, max 100)

offsetinteger

Number of records to skip (default 0)

Response

List of lock sessions

oktrue required

Example response

{
  "data": {
    "pagination": {
      "limit": 50
    }
  }
}

Changes

  • 682fc4d7f6d5Revision changes
    • breaking

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

  • 2411203b3c10Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API