Skip to main content
GET
Preview invite

Path Parameters

inviteCode
string
required

The invite code to use for joining the workspace.

Response

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.

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.

createdAt
string<date-time>
required

Timestamp when the workspace was created.

displayName
string
required

Display name of the workspace.

expiresAt
string<date-time>
required

When the invite expires.

invitedRole
required

Role the user will have if they join.

Allowed value: "owner"
workspaceSlug
string
required

Handle of the workspace.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description
string

Description of the workspace.