Get workspace details | Docmost Octri Preview

2 status codes

200Returns the workspace details.

dataobjectoptional

statusintegeroptional

successbooleanoptional

404Returned when the workspace cannot be found.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

A 404 is returned when the authenticated user has no workspace to retrieve. The authenticated user must be associated with an existing workspace.

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.getInfo();

{
  "data": {
    "billingEmail": "user@example.com",
    "createdAt": "2026-01-15T09:00:00Z",
    "customDomain": "example_value",
    "defaultRole": "example_value",
    "defaultSpaceId": "550e8400-e29b-41d4-a716-446655440000",
    "deletedAt": "2026-01-15T09:00:00Z",
    "description": "Example description",
    "emailDomains": "user@example.com",
    "enforceMfa": "example_value",
    "enforceSso": true,
    "hostname": "Example Name",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "isScimEnabled": "example_value",
    "logo": "example_value",
    "name": "Example Name",
    "plan": "example_value",
    "settings": "example_value",
    "status": "active",
    "stripeCustomerId": "550e8400-e29b-41d4-a716-446655440000",
    "trashRetentionDays": "example_value",
    "trialEndAt": "2026-01-15T09:00:00Z",
    "updatedAt": "2026-01-15T09:00:00Z"
  },
  "status": 200,
  "success": true
}

Response

Errors