# Retrieve MSP bulk license pools (deprecated)

Retrieves all MSPs bulk entitlements for the authenticated tenant. MSP bulk entitlements are large license pools that MSPs purchase and can then allocate to their customer tenants through assignments. Each entitlement includes details such as device type, SKUs, quantity, effective date, expiration date, and trial status. The response returns a list of MspEntitlement objects containing all bulk licenses available to the MSP. This method will be removed no sooner than 08/31/2026. The following endpoint /entitlements/query can be used for this content.

Endpoint: GET /mspEntitlements
Version: v0.2.0

## Response 200 fields (application/json):

  - `alm` (boolean)
    Indicates whether this is an ALM (advanced license management) entitlement. ALM entitlements have additional features and management capabilities compared to standard entitlements. When true, additional ALM fields like activation ID and sales order entitlement quantity may be populated.

  - `almActivationId` (string)
    Activation identifier for ALM (advanced license management) entitlements. This ID is used to track and manage ALM license activations. Only present and relevant when the 'alm' field is true.
    Example: "ALM-ACT-123456"

  - `almSoEntQuantity` (integer)
    SO (sales order) entitlement quantity for ALM licenses. Represents the quantity specified in the sales order for this ALM entitlement. Only populated for ALM entitlements when 'alm' field is true.
    Example: 500

  - `deviceSubType` (string)
    The specific subtype or variant within the device type category (e.g., Indoor AP, Outdoor AP). Provides granular categorization of devices covered by this entitlement. Derived from the licenseType.

  - `deviceType` (string)
    The category of device this entitlement applies to (e.g., AP for access points, SW for switches). This is a hierarchical categorization where device types can have multiple subtypes. Derived from the licenseType for database efficiency.
    Enum: "MSP_WIFI", "MSP_SWITCH", "MSP_EDGE", "MSP_APSW", "MSP_SLTN_TOKEN"

  - `effectiveDate` (string)
    Date and time when this entitlement becomes active and can start being used or assigned. Entitlements cannot be used before this date. Typically set to the purchase or contract start date.
    Example: "2024-01-01T00:00:00Z"

  - `expirationDate` (string)
    Date and time when this entitlement expires and can no longer be used or assigned. For API responses, this is returned as 23:59:59 on the expiration day (entitlements are valid all day on the expiration date). Internally stored as the exact date from the licensing system.
    Example: "2024-12-31T23:59:59Z"

  - `id` (string)

  - `isR1Sku` (string)
    This flag helps identify entitlements that are part of the ruckus one platform.
    Example: true

  - `isTrial` (boolean)
    Indicates whether this is a trial/temporary MSP entitlement. Trial entitlements are temporary evaluation licenses that allow MSPs to test functionality before purchasing full licenses. Determined by checking if the SKU ends with '-TEMP' or contains 'TMP090'. When true, this is a trial entitlement; when false, it's a standard purchased entitlement.

  - `lastNotificationDate` (string)
    Date when the most recent expiration notification was sent to the tenant for this entitlement. Used to track notification history and prevent duplicate notifications. Stored as date value without time in UTC timezone.
    Example: "2024-11-30"

  - `quantity` (integer)
    Total number of licenses available in this MSP entitlement pool. This represents the bulk quantity that the MSP can allocate to their customer tenants through assignments. Must be a positive number.
    Example: 1000

  - `r1Sku` (boolean)
    This flag helps identify entitlements that are part of the ruckus one platform.
    Example: true

  - `sku` (string)
    SKU (stock keeping unit) identifier for this entitlement as assigned by the licensing system. Used for product identification, ordering, and inventory management. May contain suffixes like '-TEMP' for trial licenses or 'TMP090' for temporary entitlements.
    Example: "APSW-MSP100-001"

  - `skuTier` (string)
    Service tier or level associated with this SKU (e.g., Bronze, Silver, Gold, Platinum). Indicates the service level and feature set included with the entitlement. Optional field that may not be present for all SKUs.
    Example: "Gold"

  - `status` (string)
    Enum: "FUTURE", "VALID", "EXPIRED"