Skip to content
Docs
Operation

List Users in Account

GET/user-accounts/account/{accountId}
Get all users who have access to a specific account. Returns each user along with their role(s) for that account. This is useful for showing the team members in an account or building an account-level permissions page.

When to use this

  • Showing who can access a specific account
  • Building team management interfaces
  • Reviewing permissions before removing an account

Path parameters

accountIdstringRequired
Account ID

Returns

Role assignments retrieved

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
Users can have multiple roles in the same account-check the roles array for each result.

Related

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// List useraccountrolesbyaccountconst { useraccountrolesbyaccount, pagination } = await client.useraccountrolesbyaccount.list({  limit: 20,  page: 1,});for (const item of useraccountrolesbyaccount) {  console.log(`${item.id}: ${item.name || item.id}`);}console.log(`Page ${pagination.page} of ${pagination.totalPages}`);
Response 200
{
  "assignments": [
    {
      "id": "uar_abc123",
      "organisationId": "org_xyz789",
      "userId": "usr_abc123",
      "accountId": "acc_xyz789",
      "roleId": "rol_system_event_manager",
      "createdAt": "2024-01-15T10:30:00Z",
      "user": {
        "id": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "account": {
        "id": "string",
        "name": "string"
      },
      "role": {
        "id": "string",
        "name": "string",
        "isSystemRole": true
      }
    }
  ]
}

Try it in test mode

Path parameters
Account ID