> ## Documentation Index > Fetch the complete documentation index at: https://docs.nvisy.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview invite > Returns workspace information for an invite code, allowing users to preview the workspace before joining. Does not require authentication. ## OpenAPI ````yaml /api-reference/openapi.json get /invites/code/{inviteCode}/ openapi: 3.1.0 info: title: Nvisy API summary: Document processing and annotation platform description: >- Nvisy provides intelligent document processing, annotation, and analysis capabilities. This API enables document upload, OCR processing, embedding generation, and semantic search across your document collections. termsOfService: https://nvisy.com/legal/terms-of-service contact: name: Nvisy Support url: https://nvisy.com email: hello@nvisy.com license: name: Proprietary url: https://nvisy.com/license version: 0.1.0 servers: [] security: [] tags: - name: Accounts description: Account management and profile operations - name: Authentication description: Login, signup, and token management - name: Workspaces description: Workspace creation and management - name: Files description: File upload, download, and management - name: Members description: Workspace member management - name: Invites description: Workspace invitation handling - name: API Tokens description: API token management - name: Connections description: External provider connections - name: Pipelines description: Redaction pipeline configuration - name: Pipeline Runs description: Pipeline run execution and review - name: Policies description: Redaction policy configuration - name: Webhooks description: Webhook configuration - name: Notifications description: Account notification management - name: Health description: Service health checks paths: /invites/code/{inviteCode}/: get: tags: - Invites summary: Preview invite description: >- Returns workspace information for an invite code, allowing users to preview the workspace before joining. Does not require authentication. parameters: - in: path name: inviteCode description: The invite code to use for joining the workspace. required: true schema: description: The invite code to use for joining the workspace. type: string style: simple responses: '200': description: >- Preview of an invite with workspace details for display before joining. This is a public-facing response that shows workspace information to help users decide whether to join via an invite code. content: application/json: schema: $ref: '#/components/schemas/InvitePreview' '400': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: InvitePreview: description: |- Preview of an invite with workspace details for display before joining. This is a public-facing response that shows workspace information to help users decide whether to join via an invite code. type: object properties: createdAt: description: Timestamp when the workspace was created. type: string format: date-time description: description: Description of the workspace. type: string displayName: description: Display name of the workspace. type: string expiresAt: description: When the invite expires. type: string format: date-time invitedRole: description: Role the user will have if they join. allOf: - $ref: '#/components/schemas/WorkspaceRole' workspaceSlug: description: Handle of the workspace. allOf: - $ref: '#/components/schemas/Handle' required: - workspaceSlug - displayName - invitedRole - createdAt - expiresAt ErrorResponse: description: |- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. type: object properties: message: description: User-friendly error message safe for client display type: string name: description: The error name/type identifier type: string resource: description: The resource that the error relates to (optional, set by handler) type: string suggestion: description: Helpful suggestion for resolving the error (optional) type: string validation: description: Validation error details for field-specific errors type: array items: $ref: '#/components/schemas/ValidationErrorDetail' required: - name - message WorkspaceRole: description: >- Defines the role and permission level of a workspace member. This enumeration corresponds to the `WORKSPACE_ROLE` PostgreSQL enum and provides hierarchical access control for workspace members with clearly defined capabilities. oneOf: - description: Full workspace ownership and management capabilities type: string const: owner - description: >- Can manage members, integrations, and settings, but cannot delete workspace or transfer ownership type: string const: admin - description: >- Can edit content and manage files, but cannot manage members or workspace settings type: string const: member - description: Read-only access to workspace content type: string const: guest Handle: description: >- Lowercase, dash-separated identifier used in URLs and as account handles. type: string maxLength: 32 minLength: 3 pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$ ValidationErrorDetail: description: Validation error details for field-specific errors. type: object properties: code: description: Error code for the validation failure type: string field: description: Field name that failed validation type: string message: description: Human-readable error message type: string params: description: Additional parameters related to the validation error type: object additionalProperties: true required: - field - code - message ````