Retrieves all licensed users data.

GET 
<your-unleash-url>/api/admin/licensed-users

Fetches an array of licensed users with date and count.

Responses

200

licensedUsersSchema

application/json

Schema

Schema

seatCountintegerrequired
The total number of licensed seats currently available for this Unleash instance.
Example: 25
licensedUsers objectrequired
An object containing historical and current licensed user data.
history object[]required
A monthly history of licensed user counts.
Array [
datedate-timerequired
The date associated with the licensed users count.
Example: 2024-10-01T00:00:00.000Z
countintegerrequired
The count of licensed users on the given date.
Example: 100
]
currentintegerrequired
The current number of licenses in use.
Example: 25

Example (auto)

{
  "seatCount": 25,
  "licensedUsers": {
    "history": [
      {
        "date": "2024-10-01T00:00:00.000Z",
        "count": 100
      }
    ],
    "current": 25
  }
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/licensed-users' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!