Skip to main content
GET
Get Invite Code
string
required
The API key for your account. You can find this in your account settings.
Generates a short-lived invite code tied to the authenticated user’s identity, not to any specific workspace. The user who wants to join shares this code out-of-band (chat, email) with a workspace owner, who then submits it via Invite Member along with the role to grant. The code expires 5 minutes after generation and is single-use: it is invalidated as soon as it is redeemed. Request a new one if it expires before the owner adds you. Rate limited to 1 code every 5 minutes per user.

Response

string
Indicates whether the call was successful.. success if successful, error if not.
string
Your workspace invite code.

Common errors