Skip to content
Docs
Operation

Get Account

GET/accounts/{id}
Fetch details about a specific account. Returns the account's name, settings, and configuration. Use this to show account information in your UI or to check settings before creating events. An account represents a division within your organisation-it could be a promoter, a department, or any other entity that needs its own events and financial tracking.

When to use this

  • Displaying account details in a settings page
  • Checking account configuration before creating events
  • Loading account info for an account switcher

Path parameters

idstringRequired
Account ID

Returns

Account 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
The account ID is included in most responses, so you rarely need to look it up separately.

Related

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Get account detailsconst account = await client.account.get('{{ACCOUNT_ID}}');console.log(`Account: ${account.name || account.id}`);
Response 200
{
  "account": {
    "id": "acc_abc123",
    "organisationId": "org_xyz789",
    "name": "Main Account",
    "status": "active",
    "isDeleted": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T14:45:00Z"
  }
}

Try it in test mode

Path parameters
Account ID