Skip to content
BookendBookend Docs

Get license state

GET
/v1/license
curl --request GET \
  --url http://localhost:8080/v1/license

Returns whether a license is installed, valid or expired, the licensed institution, tier, expiry and any validation error. Once the license has expired intake goes read-only; creating packages and uploading documents answer 422; while everything already in the system stays reachable. Any staff role or an API key with status:read.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

What the installed license currently allows.

object
installed
required
boolean
valid
required
boolean
expired
required
boolean
license
required
One of:
null
error
required
null | string
checkedAt
required
string format: date-time
intakeWritable

Intake is read-only once the license has expired; everything already in the system stays reachable.

boolean
Examplegenerated
{
  "installed": true,
  "valid": true,
  "expired": true,
  "license": {
    "institution": "example",
    "tier": "example",
    "airGapped": true,
    "expiresAt": "2026-04-15T12:00:00Z",
    "installId": "example"
  },
  "error": "example",
  "checkedAt": "2026-04-15T12:00:00Z",
  "intakeWritable": true
}