Get invitation details | Tolgee Octri Demo

1 parameter

codestringrequired

The invitation code used to retrieve invitation details.

5 status codes

200Returns invitation details, including its `code` and `id`, with available creator, invitee email, organization, and project information.

codestringrequired

createdByobjectoptional

idintegerrequired

inviteeEmailstringoptional

organizationNamestringoptional

projectNamestringoptional

400Returned when the request is invalid.

codestringrequired

Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted

paramsarray<object>optional

401Returned when authentication is missing or invalid.

codestringrequired

paramsarray<object>optional

403Returned when access to the invitation information is forbidden.

codestringrequired

paramsarray<object>optional

404Returned when no invitation is found for the supplied code.

codestringrequired

paramsarray<object>optional

Error handling

A 400 indicates an invalid request, a 401 indicates missing or invalid authentication, and a 403 indicates forbidden access. A 404 indicates that the invitation was not found; the code path parameter must identify the invitation.

import { Client } from "tolgee-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://app.tolgee.io",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.invitationInfo.get({ code: "example" });

{
  "code": "123456",
  "createdBy": {
    "avatar": "https://example.com/avatar.jpg",
    "deleted": true,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "username": "janedoe"
  },
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inviteeEmail": "user@example.com",
  "organizationName": "Example Name",
  "projectName": "Example Name"
}

Request

Response

Errors