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	Number of unassigned licenses available for allocation.
id	integer	Internal product/license identifier.
friendlyName	string	Human-readable name of the Microsoft subscription SKU.
guid	string($uuid) (path)	'CustomerGuid' value created in the Live Platform customer tenant SQL database directory.
needPhoneSystem	boolean	Indicates whether a Teams Phone System license is required or expected in addition to this SKU.
overridePhoneSystemSku	string	Optional alternate Phone System SKU to associate with this license when phone capabilities are required.

■

404 Not Found

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter	Type	Description
type	string	Error type
title	string	Email title
status	integer	StatusCodes.Status400BadRequest
detail	string	Additional error details.
instance	string	HttpContext.Request.Path
errorTicket	string	errId.ToString()
errorCode	string	Error code output in the request
traceId	string	HttpContext.TraceIdentifier
additionalProp1	string	Error related to Custom script parameter
additionalProp2	string	Error related to Custom script parameter
additionalProp3	string	Error related to Custom script parameter

■

500 Internal Server Error

See fields above