Invitations
Invitations
Section titled “Invitations”User and team invitation management, onboarding workflows, and access provisioning.
Overview
Section titled “Overview”The Invitations rail manages user onboarding:
- Send invitations — Invite users to tenants, workspaces, or specific roles
- Invitation lifecycle — Track pending, accepted, expired, and revoked invitations
- Bulk invitations — Send invitations to multiple users via CSV upload
- Onboarding flow — Guided setup for newly invited users
- Expiration policies — Configurable invitation expiry (default: 7 days)
Key Concepts
Section titled “Key Concepts”| Concept | Description |
|---|---|
| Invitation Token | Unique, time-limited token for accepting an invitation |
| Inviter | User who creates the invitation |
| Invitee | User being invited (identified by email) |
| Role Assignment | Role granted upon acceptance (viewer, editor, admin) |
| Workspace Scope | Invitation can be scoped to specific workspaces |
Invitation States
Section titled “Invitation States”Created → Sent → Pending → Accepted / Expired / RevokedEndpoints
Section titled “Endpoints”Refer to the API Explorer for interactive endpoint documentation.
Authentication
Section titled “Authentication”All endpoints require authentication via Bearer token or API key.
Rate Limiting
Section titled “Rate Limiting”Standard rate limits apply. See Rate Limiting for details.