Skip to content
Docs
Open Backstage
Operation

List Venue Layouts

GET/venues/{id}/layouts
Get all the seating layouts across your venues. Returns layouts with their capacity and configuration details. Filter by venue to see just the layouts for one location. Each venue can have multiple layouts for different configurations-concerts vs theatre shows, full capacity vs socially distanced, etc.

When to use this

  • Populating a layout picker when creating an event
  • Showing all available configurations for a venue
  • Auditing seating capacity across venues

Path parameters

idstringRequired
Venue ID

Query parameters

searchstringOptional
Search layouts by name
statusstringOptional
Filter by layout status
accountIdstringOptional
Filter by account ID
pagestringOptional
Page number
limitstringOptional
Items per page (max 100)

Returns

Venue layouts 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
Filter by `venueId` to see layouts for a specific venue.

Related

import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({  organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// List venuelayoutsconst { venuelayouts, pagination } = await client.venuelayouts.list({  limit: 20,  page: 1,});for (const item of venuelayouts) {  console.log(`${item.id}: ${item.name || item.id}`);}console.log(`Page ${pagination.page} of ${pagination.totalPages}`);
Response 200
{
  "venueLayouts": [
    {
      "id": "vlt_abc123",
      "venueId": "vnu_def456",
      "organisationId": "org_xyz789",
      "accountId": "acc_ghi012",
      "name": "Theatre Mode",
      "description": "Standard theatre configuration",
      "status": "active",
      "totalCapacity": 1500,
      "categories": [],
      "areas": [],
      "decorations": [],
      "tags": [
        "theatre",
        "seated"
      ],
      "isDeleted": false,
      "createdAt": "2024-12-28T10:30:00Z",
      "updatedAt": "2024-12-28T14:45:00Z",
      "createdBy": "usr_abc123"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

Try it in test mode

Path parameters
Venue ID
Query parameters
Search layouts by name
Filter by layout status
Filter by account ID
Page number
Items per page (max 100)