latestOpenAPI 3.0.02026-08-08270135.7 KB

c1404d1545ba

workspace
invites

Create invite

Create a new invite for the workspace.

You can create:
- Email-based invites (send to a specific email)
- Invite links (with optional restrictions and usage limits)

**Use cases:**
- Inviting new members to the workspace
- Generating invite links for onboarding
- Automating team invitations
post/api/v1/workspaces/invites

Request body

OR

Response

This response returns the details of the newly created workspace invite.

idstring required
createdstring required
type'link' | 'email' required
status'pending' | 'redeemed' | 'rejected' required
emailstring required
role'member' | 'admin' required
resolvedAtstring required
redeemedBystring required
usesnumber
restrictedDomainsstring[]