Retrieves a paginated list of the current user's active license sessions.

GET

/api/v1/provision/consumer/me/sessions

curl --request GET \
  --url 'https://example.com/api/v1/provision/consumer/me/sessions?pageNumber=1&pageSize=100'

This endpoint provides a view of all licenses currently activated by the user across all their devices. It is useful for displaying a user’s “My Licenses” or “My Devices” page in a portal.

Parameters

Query Parameters

pageNumber

integer | string format: int32

default: 1 /^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

default: 100 /^-?(?:0|[1-9]\d*)$/

Responses

200

Returns the list of active license sessions.

object

pageNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

totalCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

items

Array<object>

object

id

string format: uuid

isTrial

boolean

isValidSession

boolean

activationTime

string format: date-time

lastAccessTime

string format: date-time

leaseExpiration

string format: date-time

graceExpiration

string format: date-time

leaseTime

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

trialExpiration

string format: date-time

isRevoked

boolean

fingerprint

string

deviceName

Optional display name of the device where the license is activated. Useful for management UIs and user identification of licensed devices.

null | string

applicationInstanceId

Identifies the specific process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.

null | string

activationCode

string

licenseKey

null | string

entitlementId

string format: uuid

appliedPlanSetId

null | string format: uuid

appliedPlanName

null | string

licensedProducts

Array<string>

cannotActivateBeforeTimestamp

string format: date-time

notValidAfterTimestamp

string format: date-time

userId

string format: uuid

email

string

totalPages

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasPreviousPage

boolean

hasNextPage

boolean

object

pageNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

totalCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

items

Array<object>

object

id

string format: uuid

isTrial

boolean

isValidSession

boolean

activationTime

string format: date-time

lastAccessTime

string format: date-time

leaseExpiration

string format: date-time

graceExpiration

string format: date-time

leaseTime

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

trialExpiration

string format: date-time

isRevoked

boolean

fingerprint

string

deviceName

Optional display name of the device where the license is activated. Useful for management UIs and user identification of licensed devices.

null | string

applicationInstanceId

Identifies the specific process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.

null | string

activationCode

string

licenseKey

null | string

entitlementId

string format: uuid

appliedPlanSetId

null | string format: uuid

appliedPlanName

null | string

licensedProducts

Array<string>

cannotActivateBeforeTimestamp

string format: date-time

notValidAfterTimestamp

string format: date-time

userId

string format: uuid

email

string

totalPages

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasPreviousPage

boolean

hasNextPage

boolean

Example ^generated

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalCount": 1,
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "isTrial": true,
      "isValidSession": true,
      "activationTime": "2026-04-15T12:00:00Z",
      "lastAccessTime": "2026-04-15T12:00:00Z",
      "leaseExpiration": "2026-04-15T12:00:00Z",
      "graceExpiration": "2026-04-15T12:00:00Z",
      "leaseTime": "example",
      "trialExpiration": "2026-04-15T12:00:00Z",
      "isRevoked": true,
      "fingerprint": "example",
      "deviceName": "example",
      "applicationInstanceId": "example",
      "activationCode": "example",
      "licenseKey": "example",
      "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "appliedPlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "appliedPlanName": "example",
      "licensedProducts": [
        "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      ],
      "cannotActivateBeforeTimestamp": "2026-04-15T12:00:00Z",
      "notValidAfterTimestamp": "2026-04-15T12:00:00Z",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "email": "example"
    }
  ],
  "totalPages": 1,
  "hasPreviousPage": true,
  "hasNextPage": true
}

object

pageNumber

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

pageSize

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

totalCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

items

Array<object>

object

id

string format: uuid

isTrial

boolean

isValidSession

boolean

activationTime

string format: date-time

lastAccessTime

string format: date-time

leaseExpiration

string format: date-time

graceExpiration

string format: date-time

leaseTime

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

trialExpiration

string format: date-time

isRevoked

boolean

fingerprint

string

deviceName

Optional display name of the device where the license is activated. Useful for management UIs and user identification of licensed devices.

null | string

applicationInstanceId

Identifies the specific process that holds this license when concurrent licensing is enabled. Relevant when multiple processes on the same hardware require separate licenses.

null | string

activationCode

string

licenseKey

null | string

entitlementId

string format: uuid

appliedPlanSetId

null | string format: uuid

appliedPlanName

null | string

licensedProducts

Array<string>

cannotActivateBeforeTimestamp

string format: date-time

notValidAfterTimestamp

string format: date-time

userId

string format: uuid

email

string

totalPages

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasPreviousPage

boolean

hasNextPage

boolean

Example ^generated

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalCount": 1,
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "isTrial": true,
      "isValidSession": true,
      "activationTime": "2026-04-15T12:00:00Z",
      "lastAccessTime": "2026-04-15T12:00:00Z",
      "leaseExpiration": "2026-04-15T12:00:00Z",
      "graceExpiration": "2026-04-15T12:00:00Z",
      "leaseTime": "example",
      "trialExpiration": "2026-04-15T12:00:00Z",
      "isRevoked": true,
      "fingerprint": "example",
      "deviceName": "example",
      "applicationInstanceId": "example",
      "activationCode": "example",
      "licenseKey": "example",
      "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "appliedPlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "appliedPlanName": "example",
      "licensedProducts": [
        "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      ],
      "cannotActivateBeforeTimestamp": "2026-04-15T12:00:00Z",
      "notValidAfterTimestamp": "2026-04-15T12:00:00Z",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "email": "example"
    }
  ],
  "totalPages": 1,
  "hasPreviousPage": true,
  "hasNextPage": true
}

401

If the user is not authenticated.

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

If the caller lacks the required permission.

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}