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
Parameters
idpathrequiredAccount ID
Response
Account retrieved successfully
Notes
💡The account ID is included in most responses, so you rarely need to look it up separately.
Code Samples
Get Account using the TypeScript SDK:
import { BackstageClient } from '@ticketlayer/backstage';
const client = new BackstageClient({
organisationSlug: 'your-org',
});
client.setAccessToken('YOUR_ACCESS_TOKEN');
// Get account details
const account = await client.account.get('{{ACCOUNT_ID}}');
console.log(`Account: ${account.name || account.id}`);