Get workspace invitation details | Docmost Octri Preview

1 body field

Identifies the invitation to retrieve.

invitationIdstringrequired

UUID of the invitation to retrieve.

2 status codes

200Returns the invitation details.

dataobjectoptional

statusintegeroptional

successbooleanoptional

404Returned when the invitation cannot be found.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

invitationId is required and must be a valid UUID. A 404 is returned when no invitation exists with the supplied invitationId.

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.getInvitationById({ invitationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "data": {
    "createdAt": "2026-01-15T09:00:00Z",
    "email": "user@example.com",
    "enforceSso": true,
    "groupIds": "example_value",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "invitedById": "550e8400-e29b-41d4-a716-446655440000",
    "role": "administrator",
    "updatedAt": "2026-01-15T09:00:00Z",
    "workspaceId": "550e8400-e29b-41d4-a716-446655440000"
  },
  "status": 200,
  "success": true
}

Request

Response

Errors