List Invitations
GET
/users/invitationsSee all pending invitations for your organisation.
Shows who's been invited, when their invitation expires, and whether they've
accepted yet. Useful for following up with people who haven't responded.
Only shows pending invitations-once accepted, they become regular users.
When to use this
- Checking who hasn't accepted their invitation yet
- Building an invitation management screen
- Finding invitations that are about to expire
Parameters
organisationIdquerystatusqueryResponse
Invitations retrieved successfully
Notes
💡Filter by status to see only pending, expired, or redeemed invitations.
Code Samples
List User Invitations using the TypeScript SDK:
import { BackstageClient } from '@ticketlayer/backstage';
const client = new BackstageClient({
organisationSlug: 'your-org',
});
client.setAccessToken('YOUR_ACCESS_TOKEN');
// List userinvitations
const { userinvitations, pagination } = await client.userinvitations.list({
limit: 20,
page: 1,
});
for (const item of userinvitations) {
console.log(`${item.id}: ${item.name || item.id}`);
}
console.log(`Page ${pagination.page} of ${pagination.totalPages}`);