Skip to content
Docs
Open Backstage
Operation

List Invitations

GET/users/invitations
See 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

Query parameters

organisationIdstringOptional
statusstringOptional

Returns

Invitations retrieved successfully

Errors

400
Bad Request - Invalid input
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error

Every error names its code and links to it. All error codes

Notes

Tip
Filter by status to see only pending, expired, or redeemed invitations.

Related

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// List userinvitationsconst { 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}`);
Response 200
{
  "invitations": [
    {
      "id": "inv_abc123",
      "organisationId": "org_xyz789",
      "userId": "usr_pending123",
      "code": "inv_BvQ8mK...",
      "email": "newuser@example.com",
      "expiresAt": "2024-01-08T00:00:00.000Z",
      "redeemedAt": null,
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Try it in test mode

Query parameters