Skip to main content
GET
Get License Availability

Licenses Availability

Retrieve license pool limits, current usage, and remaining licenses for each tier.

Endpoint

Description

Returns the license pool status for all license tiers, including limits, current usage, and remaining capacity. Admin-only endpoint.

Authentication

Required: API Key with admin privileges

Request

Response

Success Response (200)

Response Fields

Error Responses

401 Unauthorized

403 Forbidden

Notes

  • Admin-only endpoint
  • Remaining may be reported as Infinity when no pool limit is enforced for that tier
  • Values are organization-wide aggregates

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Response

License availability

success
boolean
Example:

true

limits
object
Example:
usage
object
Example:
remaining
object
Example: