get-licenses.md

Get Licenses

Retrieves a list of all registered licenses in the workspace.

{% hint style="info" %} It requires view-privileged-setting permission. {% endhint %}

URL	Requires Auth	HTTP Method
/api/v1/licenses.get	yes	GET

Headers

Argument	Example	Required	Description
X-User-Id	myuser-name	Required	The authenticated user ID.
X-Auth-Token	myauth-token	Required	Auth token.

Example Call

curl --location 'http://localhost:3000/api/v1/licenses.maxActiveUsers' \
--header 'x-auth-token: fjiPBhtyFAn5JO3RDdDvKjkXToV2pd4_lb-nkdgJ_Q4' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ'

Example Result

Success

{
    "licenses": [
        {
            "version": 2,
            "url": "localhost:3000",
            "expiry": "2023-07-13",
            "maxActiveUsers": 25,
            "maxGuestUsers": 125,
            "maxRoomsPerGuest": 1,
            "modules": [
                "auditing",
                "canned-responses",
                "ldap-enterprise",
                "livechat-enterprise",
                "voip-enterprise",
                "omnichannel-mobile-enterprise",
                "engagement-dashboard",
                "push-privacy",
                "scalability",
                "teams-mention",
                "saml-enterprise",
                "oauth-enterprise",
                "device-management",
                "federation",
                "videoconference-enterprise",
                "message-read-receipt"
            ],
            "tag": {
                "name": "Enterprise",
                "color": "#F3BE08"
            },
            "meta": {
                "trial": false,
                "trialEnd": "2023-04-27T23:00:00Z",
                "workspaceId": "63cfe8550c95db00013d7798"
            }
        }
    ],
    "success": true
}

Error

Any of the following errors can occur on the endpoint.

• Authorization: Requires an authentication token for the request to be made.
• No permission: This occurs when the authenticated user doesn't have view-privileged-setting permission.

{% tabs %} {% tab title="Authorization" %}

{
    "status": "error",
    "message": "You must be logged in to do this."
}

{% endtab %}

{% tab title="No permission" %}

{
    "success": false,
    "error": "unauthorized"
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
3.10.0	Added