Lists activation invitations for the entitlement.

GET

/api/v1/provision/operational/entitlements/{entitlementId}/activation-codes

curl --request GET \
  --url https://example.com/api/v1/provision/operational/entitlements/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activation-codes

Parameters

Path Parameters

entitlementId

required

string format: uuid

Target entitlement.

Query Parameters

pageNumber

integer | string format: int32

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

1-based page index.

pageSize

integer | string format: int32

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

Page size.

sortOrder

string

Optional sort expression.

filter

string

Optional filter expression.

Responses

200

OK

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

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

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

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

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

maxVerificationCodeUseCount

integer | string format: int32

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

activationCodeUseCount

integer | string format: int32

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

maxActivationCodeUseCount

integer | string format: int32

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

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

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

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

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

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

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

maxVerificationCodeUseCount

integer | string format: int32

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

activationCodeUseCount

integer | string format: int32

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

maxActivationCodeUseCount

integer | string format: int32

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

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

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",
      "email": "example",
      "activationRequiresValidDeviceId": true,
      "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "activationCode": "example",
      "fingerprint": "example",
      "registeredFingerprints": [
        "example"
      ],
      "maxDeviceActivations": 1,
      "userConsent": true,
      "requiresUserConsent": true,
      "sendUserNotification": true,
      "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "activationTimeStamp": "2026-04-15T12:00:00Z",
      "expirationTimeStamp": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z",
      "verificationCodeUseCount": 1,
      "maxVerificationCodeUseCount": 1,
      "activationCodeUseCount": 1,
      "maxActivationCodeUseCount": 1,
      "isTrialActivation": true,
      "useEntitlementMaxActivations": true,
      "isDeleted": true,
      "requiredAuthenticationLevel": 1
    }
  ],
  "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

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

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

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

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

maxVerificationCodeUseCount

integer | string format: int32

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

activationCodeUseCount

integer | string format: int32

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

maxActivationCodeUseCount

integer | string format: int32

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

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

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",
      "email": "example",
      "activationRequiresValidDeviceId": true,
      "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "activationCode": "example",
      "fingerprint": "example",
      "registeredFingerprints": [
        "example"
      ],
      "maxDeviceActivations": 1,
      "userConsent": true,
      "requiresUserConsent": true,
      "sendUserNotification": true,
      "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "activationTimeStamp": "2026-04-15T12:00:00Z",
      "expirationTimeStamp": "2026-04-15T12:00:00Z",
      "createdAt": "2026-04-15T12:00:00Z",
      "verificationCodeUseCount": 1,
      "maxVerificationCodeUseCount": 1,
      "activationCodeUseCount": 1,
      "maxActivationCodeUseCount": 1,
      "isTrialActivation": true,
      "useEntitlementMaxActivations": true,
      "isDeleted": true,
      "requiredAuthenticationLevel": 1
    }
  ],
  "totalPages": 1,
  "hasPreviousPage": true,
  "hasNextPage": true
}

404

Not Found

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"
}