Booking API v2 Specification

Version: 1.58.0-33

Version 2 constitutes a complete architectural overhaul of our API, building upon the foundation of version 1 while implementing key enhancements based on operational experience and customer feedback. Key features: * Consolidated composite keys replaced with single identifiers * Redesigned entity relationships for improved data integrity * Streamlined booking and pricing workflows * Enhanced bulk operation capabilities The API provides comprehensive endpoints for: * Event lifecycle management * Venue configuration and operations * Booking process automation * Dynamic pricing control with full CRUD operations across all entities Implementation requirements: * Rate limiting: Applied uniformly across all endpoints * Error handling: Robust error management protocols are mandatory * Token caching: Strongly recommended for optimal performance Authentication Protocol: * All API requests are restricted to authenticated users. You must include your tenant or organization token in each request header as follows: X-API-Key: {tenantToken/organizationToken} If you use your tenant token, also provide the X-Organization-ID header as follows: X-Organization-ID: {id of the organization} Note: Your token is provided in the login response from the Editor application. To learn more about access options, refer to \"Managing access\" (https://landing.seatmap.dev/knowledge-base/venue-editor/access/).

Access

Authentication Methods

  • APIKey KeyParamName: X-API-Key, KeyInQuery: false, KeyInHeader: true

  • APIKey KeyParamName: X-Organization-ID, KeyInQuery: false, KeyInHeader: true

Endpoints

Booking

Operations for seat and GA area management, including locking/unlocking seats, handling sales status, and reverting sales. Supports real-time booking control and capacity management.

lock

POST /api/private/v2.0/booking/lock

Lock a seat or GA

Description

Seat should be available

Parameters
Body Parameter
Name Description Required Default Pattern

StateSelection

StateSelection

X
Query Parameters
Name Description Required Default Pattern

eventId

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 1. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

revertSale

POST /api/private/v2.0/booking/revertsale

Transfer seat or GA to the state active

Description

This feature applicable only in a sales control mode

Parameters
Body Parameter
Name Description Required Default Pattern

StateSelection

StateSelection

X
Query Parameters
Name Description Required Default Pattern

eventId

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 2. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

sale

POST /api/private/v2.0/booking/sale

Transfer seat or GA to the state sold

Description

This feature applicable only in a sales control mode

Parameters
Body Parameter
Name Description Required Default Pattern

StateSelection

StateSelection

X
Query Parameters
Name Description Required Default Pattern

eventId

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 3. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

unLock

POST /api/private/v2.0/booking/unlock

Unlock a seat or GA

Description

For GA unlocking capacity counter shall be specified

Parameters
Body Parameter
Name Description Required Default Pattern

StateSelection

StateSelection

X
Query Parameters
Name Description Required Default Pattern

eventId

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 4. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

EventEventDetails

Complete event lifecycle management including creation, scheduling, updates, and deletion. Supports pagination and detailed event configuration.

addEvent

POST /api/private/v2.0/events/

Create an event

Description

Binds an event

Parameters
Body Parameter
Name Description Required Default Pattern

Event

Event

X
Return Type

Event

Content Type

  • /

Responses
Table 5. HTTP Response Codes
Code Message Datatype

200

Returns created object

Event

400

Input data is not valid

Event

403

Forbidden. Please use correct private key.

Event

deleteEventById

DELETE /api/private/v2.0/events/{id}

Delete an event

Description

Binds an event

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 6. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

getEventById

GET /api/private/v2.0/events/{id}

Retrieves a specific event by id

Description

Getting event by Id

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

EventExpand

Content Type

  • /

Responses
Table 7. HTTP Response Codes
Code Message Datatype

200

Returns object

EventExpand

400

Input data is not valid

EventExpand

403

Forbidden. Please use correct credentials.

EventExpand

getEvents

GET /api/private/v2.0/events/

Retrieve list of all events

Description

Getting all the events with paging

Parameters
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null

id

-

null

schemaId

-

null

name

-

null

startDate

-

null

endDate

-

null
Return Type

PageEventExpand

Content Type

  • /

Responses
Table 8. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

PageEventExpand

400

Input data is not valid

PageEventExpand

403

Forbidden. Please use correct credentials.

PageEventExpand

updateEvent

PUT /api/private/v2.0/events/

Update an event

Description

Binds an event

Parameters
Body Parameter
Name Description Required Default Pattern

Event

Event

X
Return Type

Event

Content Type

  • /

Responses
Table 9. HTTP Response Codes
Code Message Datatype

200

Returns updated object

Event

400

Input data is not valid

Event

403

Forbidden. Please use correct private key.

Event

Pricing

Price management operations for events including creation, retrieval, updates, and deletion of pricing structures. Supports bulk operations and pagination.

assignPrice

POST /api/private/v2.0/event/{eventId}/prices/assignments/

Assign a price to seats and group of seats

Description

Assign a price to seats and group of seats

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Body Parameter
Name Description Required Default Pattern

Selection

Selection

X
Return Type

[Boolean]

Content Type

  • /

Responses
Table 10. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

cleanAllAssignments

DELETE /api/private/v2.0/event/{eventId}/prices/assignments/all/

Clean all assignments to seats and group of seats

Description

Clean all assignments to seats and group of seats

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 11. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

cleanAssignmentsBySeatIdAndGroupOfSeatsId

DELETE /api/private/v2.0/event/{eventId}/prices/assignments/

Clean assignments by seats and group of seats

Description

Clean assignments by seats and group of seats

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Body Parameter
Name Description Required Default Pattern

CleanAssignment

CleanAssignment

X
Return Type

[Boolean]

Content Type

  • /

Responses
Table 12. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

getAllAssignmentsWithTheirStates

GET /api/private/v2.0/event/{eventId}/prices/assignments/

Get all assignments with their states

Description

Get all assignments with their states

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Return Type

AssignmentOnEvent

Content Type

  • /

Responses
Table 13. HTTP Response Codes
Code Message Datatype

200

Returns all price assignments with their states.

AssignmentOnEvent

400

Input data is not valid

AssignmentOnEvent

403

Forbidden. Please use correct credentials.

AssignmentOnEvent

getPriceById

GET /api/private/v2.0/event/{eventId}/prices/{id}

Retrieves a specific price by id

Description

Getting price by Id

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null

id

X

null
Return Type

Price

Content Type

  • /

Responses
Table 14. HTTP Response Codes
Code Message Datatype

200

Returns object

Price

400

Input data is not valid

Price

403

Forbidden. Please use correct credentials.

Price

getPrices

GET /api/private/v2.0/event/{eventId}/prices/

Retrieve list of all prices

Description

Getting all the prices with paging

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

PagePrice

Content Type

  • /

Responses
Table 15. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

PagePrice

400

Input data is not valid

PagePrice

403

Forbidden. Please use correct credentials.

PagePrice

priceCreate

POST /api/private/v2.0/event/{eventId}/prices/

Create a price for event

Description

Binds a price to event

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Body Parameter
Name Description Required Default Pattern

Price

Price

X
Return Type

array[Price]

Content Type

  • /

Responses
Table 16. HTTP Response Codes
Code Message Datatype

200

Returns created object

List[Price]

400

Input data is not valid

List[Price]

403

Forbidden. Please use correct private key.

List[Price]

priceDelete

DELETE /api/private/v2.0/event/{eventId}/prices/{id}

Delete a price for event

Description

Binds a price to event

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null

id

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 17. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct private key.

[Boolean]

priceUpdate

PUT /api/private/v2.0/event/{eventId}/prices/

Update a price for event

Description

Binds a price to event

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Body Parameter
Name Description Required Default Pattern

Price

Price

X
Return Type

array[Price]

Content Type

  • /

Responses
Table 18. HTTP Response Codes
Code Message Datatype

200

Returns updated object

List[Price]

400

Input data is not valid

List[Price]

403

Forbidden. Please use correct private key.

List[Price]

PricingZones

Management of venue pricing zones with support for zone creation, assignment, and bulk operations. Controls pricing area definitions and seat categorization.

addPricingZone

POST /api/private/v2.0/schemas/{schemaId}/pricing_zones/

Create a pricing zone for schema

Description

Create a pricing zone for schema

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Body Parameter
Name Description Required Default Pattern

PricingZone

PricingZone

X
Return Type

array[PricingZone]

Content Type

  • /

Responses
Table 19. HTTP Response Codes
Code Message Datatype

200

Returns created object

List[PricingZone]

400

Input data is not valid

List[PricingZone]

403

Forbidden. Please use correct credentials.

List[PricingZone]

assignPricingZone

POST /api/private/v2.0/schemas/{schemaId}/pricing_zones/assignments/

Assign a pricing zone to seats and group of seats

Description

Assign a pricing zone to seats and group of seats

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Body Parameter
Name Description Required Default Pattern

Selection

Selection

X
Return Type

[Boolean]

Content Type

  • /

Responses
Table 20. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

deletePricingZone

DELETE /api/private/v2.0/schemas/{schemaId}/pricing_zones/{id}

Delete a pricing zone for schema

Description

Delete a pricing zone for schema

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null

id

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 21. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

getPricingZones

GET /api/private/v2.0/schemas/{schemaId}/pricing_zones/

Retrieve list of all pricing zones

Description

Getting all the pricing zones with paging

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

PagePricingZone

Content Type

  • /

Responses
Table 22. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

PagePricingZone

400

Input data is not valid

PagePricingZone

403

Forbidden. Please use correct credentials.

PagePricingZone

getPricingZonesById

GET /api/private/v2.0/schemas/{schemaId}/pricing_zones/{id}

Retrieves a specific pricing zone by id

Description

Getting pricing zone by Id

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null

id

X

null
Return Type

PricingZone

Content Type

  • /

Responses
Table 23. HTTP Response Codes
Code Message Datatype

200

Returns object

PricingZone

400

Input data is not valid

PricingZone

403

Forbidden. Please use correct credentials.

PricingZone

updatePricingZone

PUT /api/private/v2.0/schemas/{schemaId}/pricing_zones/

Update a pricing zone for schema

Description

Update a pricing zone for schema

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Body Parameter
Name Description Required Default Pattern

PricingZone

PricingZone

X
Return Type

array[PricingZone]

Content Type

  • /

Responses
Table 24. HTTP Response Codes
Code Message Datatype

200

Returns updated object

List[PricingZone]

400

Input data is not valid

List[PricingZone]

403

Forbidden. Please use correct credentials.

List[PricingZone]

SchemasTopology

Comprehensive venue schema management including layout creation, cloning, and topology definitions. Handles section arrangements, seating configurations, and schema versioning.

cloneSchemaById

POST /api/private/v2.0/schemas/clone/{id}

Clone a schema

Description

Clone a schema

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

[UUID]

Content Type

  • /

Responses
Table 25. HTTP Response Codes
Code Message Datatype

200

Returns uuid.

[UUID]

400

Input data is not valid

[UUID]

403

Forbidden. Please use correct credentials.

[UUID]

createSchema

POST /api/private/v2.0/schemas/

Create a new schema

Description

Create a new schema

Parameters
Body Parameter
Name Description Required Default Pattern

Schema

Schema

X
Return Type

Schema

Content Type

  • /

Responses
Table 26. HTTP Response Codes
Code Message Datatype

200

Returns created schema

Schema

400

Input data is not valid

Schema

403

Forbidden. Please use correct credentials.

Schema

deleteSchemaById

DELETE /api/private/v2.0/schemas/{id}

Delete a schema

Description

Delete a schema

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 27. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

geSchemas

GET /api/private/v2.0/schemas/

Retrieve list of all schemas

Description

Getting all the schemas with paging

Parameters
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null

venueId

-

null
Return Type

PageSchema

Content Type

  • /

Responses
Table 28. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

PageSchema

400

Input data is not valid

PageSchema

403

Forbidden. Please use correct credentials.

PageSchema

getGroupOfSeatsBySchemaId

GET /api/private/v2.0/schemas/{schemaId}/seatmaps/

Retrieve list of all group of seats

Description

Getting all the group of seats

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Query Parameters
Name Description Required Default Pattern

parentId

-

null

type

-

null
Return Type

array[GroupOfSeats]

Content Type

  • /

Responses
Table 29. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

List[GroupOfSeats]

400

Input data is not valid

List[GroupOfSeats]

403

Forbidden. Please use correct credentials.

List[GroupOfSeats]

getSchemaById

GET /api/private/v2.0/schemas/{id}

Retrieves a specific schema by id

Description

Getting schema by Id

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

Schema

Content Type

  • /

Responses
Table 30. HTTP Response Codes
Code Message Datatype

200

Returns object

Schema

400

Input data is not valid

Schema

403

Forbidden. Please use correct credentials.

Schema

getSeatsBySectionId

GET /api/private/v2.0/schemas/{schemaId}/seatmaps/seats/

Retrieve list of seats by section id

Description

Getting all the seats

Parameters
Path Parameters
Name Description Required Default Pattern

schemaId

X

null
Query Parameters
Name Description Required Default Pattern

sectionId

X

null
Return Type

Section

Content Type

  • /

Responses
Table 31. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

Section

400

Input data is not valid

Section

403

Forbidden. Please use correct credentials.

Section

resultOfCloneSchemaById

GET /api/private/v2.0/schemas/clone/result/{uuid}

Clone a schema

Description

Clone a schema

Parameters
Path Parameters
Name Description Required Default Pattern

uuid

X

null
Return Type

CloneCommand

Content Type

  • /

Responses
Table 32. HTTP Response Codes
Code Message Datatype

200

Returns result of cloning schema

CloneCommand

400

Input data is not valid

CloneCommand

403

Forbidden. Please use correct credentials.

CloneCommand

updateSchema

PUT /api/private/v2.0/schemas/

Update a schema

Description

Update a schema

Parameters
Body Parameter
Name Description Required Default Pattern

Schema

Schema

X
Return Type

Schema

Content Type

  • /

Responses
Table 33. HTTP Response Codes
Code Message Datatype

200

Returns updated object

Schema

400

Input data is not valid

Schema

403

Forbidden. Please use correct credentials.

Schema

Selection

Endpoints for managing pricing zone assignments to seats and seating areas. Handles bulk assignments and zone mapping operations.

selection

POST /api/private/v2.0/event/{eventId}/selection/

Assign a pricing zone to seats

Description

Assign a pricing zone to seats

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Body Parameter
Name Description Required Default Pattern

Assignment

Assignment

X
Return Type

[Boolean]

Content Type

  • /

Responses
Table 34. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

unSelection

POST /api/private/v2.0/event/{eventId}/unselection/

Unassign a pricing zone to seats

Description

Unassign a pricing zone to seats

Parameters
Path Parameters
Name Description Required Default Pattern

eventId

X

null
Body Parameter
Name Description Required Default Pattern

Assignment

Assignment

X
Return Type

[Boolean]

Content Type

  • /

Responses
Table 35. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

VenuesVenueDetails

Venue management operations including creation, updates, and configuration. Handles venue details, geographical information, and associated schema relationships.

addVenue

POST /api/private/v2.0/venues/

Create a venue

Description

Create a venue

Parameters
Body Parameter
Name Description Required Default Pattern

Venue

Venue

X
Return Type

Venue

Content Type

  • /

Responses
Table 36. HTTP Response Codes
Code Message Datatype

200

Returns created object

Venue

400

Input data is not valid

Venue

403

Forbidden. Please use correct credentials.

Venue

deleteVenueById

DELETE /api/private/v2.0/venues/{id}

Delete a venue

Description

Delete a venue

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

[Boolean]

Content Type

  • /

Responses
Table 37. HTTP Response Codes
Code Message Datatype

200

Returns true if everything is ok.

[Boolean]

400

Input data is not valid

[Boolean]

403

Forbidden. Please use correct credentials.

[Boolean]

getVenueById

GET /api/private/v2.0/venues/{id}

Retrieves a specific venue by id

Description

Getting venue by Id

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

Venue

Content Type

  • /

Responses
Table 38. HTTP Response Codes
Code Message Datatype

200

Returns object

Venue

400

Input data is not valid

Venue

403

Forbidden. Please use correct credentials.

Venue

getVenues

GET /api/private/v2.0/venues/

Retrieve list of all venues

Description

Getting all the venues with paging

Parameters
Query Parameters
Name Description Required Default Pattern

page

Zero-based page index (0..N)

-

0

size

The size of the page to be returned

-

20

sort

Sorting criteria in the format: property,(asc

desc). Default sort order is ascending. Multiple sort criteria are supported. [String]

-

null
Return Type

PageVenue

Content Type

  • /

Responses
Table 39. HTTP Response Codes
Code Message Datatype

200

Returns list of objects

PageVenue

400

Input data is not valid

PageVenue

403

Forbidden. Please use correct credentials.

PageVenue

updateVenue

PUT /api/private/v2.0/venues/

Update a venue

Description

Update a venue

Parameters
Body Parameter
Name Description Required Default Pattern

Venue

Venue

X
Return Type

Venue

Content Type

  • /

Responses
Table 40. HTTP Response Codes
Code Message Datatype

200

Returns updated object

Venue

400

Input data is not valid

Venue

403

Forbidden. Please use correct credentials.

Venue

Models

Assignment

Represents an assignment of a price or state to a seat or group of seats

Field Name Required Nullable Type Description Format

objectId

X

Long

ID of the object (seat or group of seats) being assigned

int64

assignmentId

X

Long

ID of the assignment (price or state)

int64

activeCount

Integer

Count of active assignments for general admission areas

int32

AssignmentOnEvent

Field Name Required Nullable Type Description Format

seatsOnEvent

List of SeatOnEvent

gaOnEvents

List of GaOnEvent

CleanAssignment

Request object for cleaning assignments from seats and groups of seats

Field Name Required Nullable Type Description Format

seatIds

List of [long]

List of seat IDs to clean assignments from

int64

groupOfSeatIds

List of [long]

List of group of seats IDs to clean assignments from

int64

CloneCommand

Field Name Required Nullable Type Description Format

uuid

UUID

uuid

state

[String]

Enum: CREATED, IN_PROCESS, DONE, ERROR,

venueId

Long

int64

schemaId

Long

int64

organizationId

Long

int64

Event

Represents an event in the booking system

Field Name Required Nullable Type Description Format

id

UUID

Unique identifier for the event

uuid

createdDate

Date

Date and time when the event was created

date-time

start

X

Date

Start date and time of the event

date-time

endDate

X

Date

End date and time of the event

date-time

name

String

Name of the event

schemaId

X

Long

ID of the schema associated with this event

int64

EventExpand

Extended event information including venue and schema details

Field Name Required Nullable Type Description Format

id

UUID

Unique identifier for the event

uuid

createdDate

Date

Date and time when the event was created

date-time

start

X

Date

Start date and time of the event

date-time

endDate

X

Date

End date and time of the event

date-time

name

String

Name of the event

schemaId

X

Long

ID of the schema associated with this event

int64

schemaName

String

Name of the schema associated with this event

venueId

String

ID of the venue where the event takes place

venueName

String

Name of the venue where the event takes place

GaOnEvent

Field Name Required Nullable Type Description Format

priceId

Long

int64

groupOfSeatsId

Long

int64

activeCount

Integer

int32

lockedCount

Integer

int32

price

String

GroupOfSeats

Represents a group of seats in a venue schema

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the group of seats

int64

name

String

Name of the group of seats

prefix

String

Prefix used for row naming

seatPrefix

String

Prefix used for seat naming

parentId

Long

ID of the parent group of seats

int64

type

[String]

Type of the group of seats

Enum: SECTION, ROW, ENTRY, TABLE,

ga

Boolean

Indicates if this is a general admission area

schemaId

Long

ID of the schema this group belongs to

int64

pricingZoneId

Long

ID of the pricing zone this group belongs to

int64

guid

UUID

Globally unique identifier

uuid

externalId

String

External identifier for integration with other systems

shapes

List of Shape

List of shapes defining the visual representation of this group

width

Integer

Width of the group in pixels

int32

height

Integer

Height of the group in pixels

int32

left

Integer

Left position of the group in pixels

int32

top

Integer

Top position of the group in pixels

int32

angle

Integer

Rotation angle of the group in degrees

int32

PageEventExpand

Field Name Required Nullable Type Description Format

totalElements

Long

int64

totalPages

Integer

int32

first

Boolean

last

Boolean

size

Integer

int32

content

List of EventExpand

number

Integer

int32

sort

SortObject

numberOfElements

Integer

int32

pageable

PageableObject

empty

Boolean

PagePrice

Field Name Required Nullable Type Description Format

totalElements

Long

int64

totalPages

Integer

int32

first

Boolean

last

Boolean

size

Integer

int32

content

List of Price

number

Integer

int32

sort

SortObject

numberOfElements

Integer

int32

pageable

PageableObject

empty

Boolean

PagePricingZone

Field Name Required Nullable Type Description Format

totalElements

Long

int64

totalPages

Integer

int32

first

Boolean

last

Boolean

size

Integer

int32

content

List of PricingZone

number

Integer

int32

sort

SortObject

numberOfElements

Integer

int32

pageable

PageableObject

empty

Boolean

PageSchema

Field Name Required Nullable Type Description Format

totalElements

Long

int64

totalPages

Integer

int32

first

Boolean

last

Boolean

size

Integer

int32

content

List of Schema

number

Integer

int32

sort

SortObject

numberOfElements

Integer

int32

pageable

PageableObject

empty

Boolean

PageVenue

Field Name Required Nullable Type Description Format

totalElements

Long

int64

totalPages

Integer

int32

first

Boolean

last

Boolean

size

Integer

int32

content

List of Venue

number

Integer

int32

sort

SortObject

numberOfElements

Integer

int32

pageable

PageableObject

empty

Boolean

PageableObject

Field Name Required Nullable Type Description Format

offset

Long

int64

sort

SortObject

pageSize

Integer

int32

paged

Boolean

pageNumber

Integer

int32

unpaged

Boolean

Price

Represents a price category for an event

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the price

int64

name

String

Name of the price category

eventId

X

UUID

ID of the event this price belongs to

uuid

externalId

String

External identifier for integration with other systems

PricingZone

Represents a pricing zone within a venue schema

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the pricing zone

int64

name

String

Name of the pricing zone

schemaId

X

Long

ID of the schema this pricing zone belongs to

int64

Row

Represents a row of seats in a venue schema

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the row

int64

name

X

String

Name or label of the row

seats

List of Seat

List of seats in this row

Schema

Represents a venue schema with seating layout and configuration

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the schema

int64

name

String

Name of the schema

externalId

String

External identifier for integration with other systems

template

Boolean

Indicates if this schema is a template for creating other schemas

draft

Boolean

Indicates if the schema is in draft status

gaCapacity

Integer

Capacity for general admission areas

int32

seatsCapacity

Integer

Total capacity of individual seats

int32

description

String

Detailed description of the schema

preview

UUID

UUID reference to a preview image of the schema

uuid

archived

Boolean

Indicates if the schema is archived

venueId

X

Long

ID of the venue this schema belongs to

int64

venueName

String

Name of the venue this schema belongs to

thumbnail

Object

Seat

Represents a seat in a venue schema

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the seat

int64

name

String

Name or label of the seat

accessible

Boolean

Indicates if the seat is accessible for people with disabilities

hidden

Boolean

Indicates if the seat is hidden from public view

marked

Boolean

Indicates if the seat is marked for special purposes

groupOfSeatsId

Long

ID of the group of seats this seat belongs to

int64

schemaId

Long

ID of the schema this seat belongs to

int64

pricingZoneId

Long

ID of the pricing zone this seat belongs to

int64

externalId

String

External identifier for integration with other systems

SeatOnEvent

Field Name Required Nullable Type Description Format

priceId

Long

int64

seatId

Long

int64

state

[String]

Enum: ACTIVE, SOLD, LOCKED,

price

String

Section

Represents a section in a venue schema containing rows of seats

Field Name Required Nullable Type Description Format

rows

List of Row

List of rows in this section

Selection

Represents a selection of seats and groups of seats for assignment operations

Field Name Required Nullable Type Description Format

seats

List of Assignment

List of seat assignments in this selection

groupOfSeats

List of Assignment

List of group of seats assignments in this selection

Shape

Field Name Required Nullable Type Description Format

id

UUID

uuid

width

BigDecimal

height

BigDecimal

y

BigDecimal

x

BigDecimal

angle

Integer

int32

groupOfSeatsGuid

UUID

uuid

order

Integer

int32

text

String

textPosition

[String]

Enum: TOP, BOTTOM, LEFT, RIGHT,

SortObject

Field Name Required Nullable Type Description Format

empty

Boolean

sorted

Boolean

unsorted

Boolean

StateAssignment

Represents a state assignment for seats or groups of seats

Field Name Required Nullable Type Description Format

id

X

Long

Unique identifier for the state assignment

int64

capacity

Integer

Capacity for general admission areas

int32

StateSelection

Represents a selection of state assignments for seats and groups of seats

Field Name Required Nullable Type Description Format

sessionId

String

Unique session identifier for tracking the selection

groupOfSeats

List of StateAssignment

List of state assignments for groups of seats

seats

List of StateAssignment

List of state assignments for individual seats

Venue

Represents a venue where events take place

Field Name Required Nullable Type Description Format

id

Long

Unique identifier for the venue

int64

name

String

Name of the venue

address

String

Physical address of the venue

lat

Double

Latitude coordinate of the venue location

double

lng

Double

Longitude coordinate of the venue location

double

draft

Boolean

Indicates if the venue is in draft status

externalId

String

External identifier for integration with other systems