Redeem Invitation
POST
/auth/redeemAccept an invitation and set up your account.
When someone invites a user to an organisation, they receive an email with an
invitation code. This endpoint lets them redeem that code, set their password,
and get their API tokens in one step.
The invitation code is single-use and expires after 7 days.
When to use this
- Building a custom "Accept Invitation" page
- Creating a branded onboarding experience for new team members
- Integrating the invitation flow into your existing user signup process
Request Body
Response
Invitation redeemed successfully
Notes
ℹ️The user will automatically become a member of the organisation with the roles specified when the invitation was created.
⚠️Invitation codes expire after 7 days. If expired, you'll need to resend the invitation.
Code Samples
Redeem using the TypeScript SDK:
import { BackstageClient } from '@ticketlayer/backstage';
const client = new BackstageClient({
organisationSlug: 'your-org',
});
// Redeem
const result = await client.auth.redeemInvitation({ /* request body */ });
console.log('Operation completed:', result);