Skip to content
Entitlements/
/
Get Entitlements

Get Entitlements

Request

Retrieves all purchased entitlements for the authenticated tenant. Purchased entitlements represent the licenses and subscriptions acquired through purchases. Each entitlement includes details about the license type, SKU, quantity, effective dates, and expiration dates.

Query
excludeContentboolean
Headers
Content-Typestringrequired
Body
required
defaultPageSizeinteger, (int32)

Default number of records per page to use when pageSize is not explicitly specified or is invalid.

sortFieldstring

Field name to use for sorting the query results in ascending or descending order.

sortOrderstring

Sort order direction for the specified sort field, typically 'ASC' for ascending or 'DESC' for descending.

pageinteger, (int32)
pageSizeinteger, (int32)

Number of records to return per page for pagination, with automatic fallback to default if invalid.

fieldsArray of strings, unique

Set of specific field names to include in the query response, enabling selective data retrieval.

filtersobject(DynamicQueryPayloadFilterDto)

Filter criteria object containing various conditions to narrow down query results based on specific parameters.

{
  "defaultPageSize": 0,
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "filters": {
    "licenseType": [ … ],
    "isTrial": false,
    "status": [ … ],
    "expirationDateRange": { … },
    "sku": "[A-Z]+-[A-Z]+-[A-Z]+-[A-Z]+[0-9]$",
    "skuTier": "Platinum, Gold, Silver"
  }
}

Responses

success.

Body
fieldsArray of strings, unique

Set of field names that were requested to be included in the response data.

totalCountinteger, (int64)

Total number of records available that match the query criteria, used for pagination calculations.

pageinteger, (int32)
pageSizeinteger, (int32)

Maximum number of records returned in this response page.

objectIdstring

Unique identifier for the primary object or entity associated with this query response.

dataArray of any
errorsArray of objects(ErrorDto)

List of errors that occurred during processing, if any.

subsequentQueriesArray of objects(SubsequentQuery)

List of additional API calls that can be made to retrieve related or supplementary data.

Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "objectId": "string",
  "data": [
    null
  ],
  "errors": [
    { … }
  ],
  "subsequentQueries": [
    { … }
  ]
}