Get Licenses
- Print
- DarkLight
- PDF
Get Licenses
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
Deprecated/api/v1/licenses.get
Use the /licenses.info endpoint instead.
Retrieves a list of all registered licenses in the workspace.
Permission required: view-privileged-setting
Changelog
| Version | Description |
|---|---|
| 6.5.0 | Deprecated |
| 3.10.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Responses
200
OK
Success Example
{
"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
}object
licenses
Array of object
object
version
integer
url
string
expiry
string
maxActiveUsers
integer
maxGuestUsers
integer
maxRoomsPerGuest
integer
modules
Array of string
string
tag
object
name
string
color
string
meta
object
trial
boolean
trialEnd
string
workspaceId
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?