Get workspace licence tier and entitlements

2 status codes

200Returns the current workspace's licence tier and enabled features in the response `data` field, alongside the standard `status` and `success` fields.

dataobjectoptional

statusintegeroptional

successbooleanoptional

401Returned when the request is unauthorized.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

A 401 is returned when the request lacks valid authentication. Provide valid credentials for the workspace whose entitlements you need.

import { DocmostAPIUnofficialOctriFullPreview } from "docmost-octri-preview-sdk";

const client = new DocmostAPIUnofficialOctriFullPreview({
  baseUrl: "{baseUrl}/api",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.workspace.getEntitlements();

{
  "data": {
    "cloud": true,
    "features": [
      "example_value"
    ],
    "tier": "example_value"
  },
  "status": 200,
  "success": true
}

Response

Errors