Get Organisation
GET
/organisations/{id}Fetch the details of the current organisation.
Returns the organisation's name, settings, branding, and configuration. Use
this to display organisation info in your app or to check settings before
performing actions.
The organisation is determined by the `X-Ticketlayer-Org` header in your request.
When to use this
- Displaying the organisation name and logo in your app
- Loading settings for an organisation admin panel
- Checking organisation configuration before operations
Parameters
idpathrequiredOrganisation ID
Response
Organisation retrieved successfully
Notes
ℹ️This returns the organisation specified in your `X-Ticketlayer-Org` header, not all organisations you belong to.
Code Samples
Get Organisation using the TypeScript SDK:
import { BackstageClient } from '@ticketlayer/backstage';
const client = new BackstageClient({
organisationSlug: 'your-org',
});
client.setAccessToken('YOUR_ACCESS_TOKEN');
// Get organisation details
const organisation = await client.organisation.get('{{ORGANISATION_ID}}');
console.log(`Organisation: ${organisation.name || organisation.id}`);