Get Available User Licenses

This request retrieves a list of available licenses for the tenant service.

URI

Copy

{{baseUrl}}/api/v3/customer/{customerGuid}/availableLicenses

HTTP Method

GET

Request Parameters

Parameter

Type

Description

customerGuid

string($uuid)

(path)

customerGuid' value created in the Live Platform customer tenant SQL database directory:

■

Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.

■

Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

Extract this value using Get Services Brief Details (V3) or Get Customers Brief Details (V2) searching for the matching Short Name of the service.

Example Response

Copy

[
    {
        "availableUnits": 1,
        "id": 28,
        "friendlyName": "Microsoft 365 E5 EEA (no Teams)",
        "guid": "3271cf8e-2be5-4a09-a549-70fd05baaa17",
        "needPhoneSystem": false,
        "overridePhoneSystemSku": null
    }
]

Response

■

200 OK

Parameter	Type	Description
availableUnits	integer	??
id	integer	??
friendlyName	string	The type of the license that is assigned to the tenant. For example, Microsoft 365 E5 EEA (no Teams)
guid	string($uuid) (path)	???
"needPhoneSystem": false,	boolean	???
"overridePhoneSystemSku": null		???

■

404 Not Found

■

500 Internal Server Error