Skip to content
Docs
Open Backstage
Operation

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

Path parameters

idstringRequired
Organisation ID

Returns

Organisation 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

Note
This returns the organisation specified in your `X-Ticketlayer-Org` header, not all organisations you belong to.

Related

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Get organisation detailsconst organisation = await client.organisation.get('{{ORGANISATION_ID}}');console.log(`Organisation: ${organisation.name || organisation.id}`);
Response 200
{
  "organisation": {
    "id": "org_xyz789",
    "name": "Acme Corporation",
    "primaryColor": "#FF5733",
    "secondaryColor": "#3366FF",
    "logoUrl": "https://example.com/logo.png",
    "metadata": {
      "industry": "Technology",
      "size": "Medium"
    },
    "apiVersion": "2026-10-02",
    "testMode": false,
    "allowApiKeyLedgerRead": false,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T14:45:00Z"
  }
}

Try it in test mode

Path parameters
Organisation ID