Developer Hub
»
Tickets GET API Documentation
Get Event Tickets: /events/{event_uuid}/tickets
GET
https://api-rto.eventbookings.com/v3/events/{event_uuid}/tickets
Try It Out
Purpose
Retrieve a detailed list of tickets associated with a specific event. Each ticket includes information about the attendee, product details, session details, and event organisation.
Scope
event.list_ticket → Ticket list permission must be granted from the application to view event tickets list.
Use Case
This endpoint is used to fetch ticket information for an event. It is useful for event organisers to monitor ticket sales, attendee details, and session participation.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier of the event whose informations are to be retrieved. |
Query Parameters
|
Parameter |
Type |
Allowed Value |
Description |
|---|---|---|---|
|
position |
number |
Any positive integer |
Position number to specify the start point. |
|
rows |
number |
20 to 100 |
Number of rows to return in the response. |
|
order_by |
string |
Any column name |
Specify the sorting column (A to Z). |
|
occurrence_start_on |
datetime |
yyyy-mm-dd hh:mm (local) |
Filter by session occurrence start time. |
|
session_uuid |
uuid |
Valid UUID string |
Filter by specific session UUID. |
Request Body
No request body is required for this endpoint.
Response
The response provides detailed information about tickets, events, and associated entities. Each ticket includes a unique identifier (uuid), serial number, codes (type, value, and image), special instructions, and attendee details. Attendee information is nested, with each attendee having attributes like field names, types, and values. The product section describes the ticket details, such as name, variation, description, and session information, including session UUIDs, names, and dates in both UTC and local time. The event details include its UUID, name, display name, timezone, banner information, configuration, and start/end times. The organisation (org) section provides the UUID, name, slug, and image of the organiser. Other key attributes include reference and invoice numbers, seating details, scanning settings, last attendee update timestamps, attendance settings, and ticket IDs. Additionally, the response includes an attendance count, showing how many have attended or not, and pagination details, such as total records, current position, and rows per page.
JSON
{
"tickets": [
{
"uuid": "TICKET_UUID",
"serial": "SERIAL_NUMBER",
"codes": {
"type": "CODE_TYPE",
"value": "CODE_VALUE",
"image": "IMAGE_PATH"
},
"special_instruction": "SPECIAL_INSTRUCTION",
"attendee_details": [
{
"uuid": "ATTENDEE_UUID",
"attributes": [
{
"field_name": "FIELD_NAME",
"field_type": "FIELD_TYPE",
"field_value": "FIELD_VALUE"
}
]
}
],
"product": {
"ticket_name": "TICKET_NAME",
"ticket_variation": "TICKET_VARIATION",
"ticket_description": "TICKET_DESCRIPTION",
"sell_session": true,
"sessions": [
{
"session_uuid": "SESSION_UUID",
"session_name": "SESSION_NAME",
"session_date": {
"utc": "SESSION_DATE_UTC",
"local": "SESSION_DATE_LOCAL"
}
}
]
},
"order": {
"uuid": "ORDER_UUID"
},
"event": {
"uuid": "EVENT_UUID",
"name": "EVENT_NAME",
"display_name": "DISPLAY_NAME",
"timezone": "TIMEZONE",
"banner": [
{
"name": "BANNER_NAME",
"image": "BANNER_IMAGE",
"primary": true
}
],
"configuration": [],
"event_starts_on": {
"utc": "EVENT_STARTS_UTC",
"local": "EVENT_STARTS_LOCAL"
},
"event_ends_on": {
"utc": "EVENT_ENDS_UTC",
"local": "EVENT_ENDS_LOCAL"
}
},
"org": {
"uuid": "ORG_UUID",
"name": "ORG_NAME",
"slug": "ORG_SLUG",
"image": "ORG_IMAGE"
},
"reference_no": "REFERENCE_NO",
"invoice_no": "INVOICE_NO",
"seat": "SEAT",
"disable_scanning": {
"value": false,
"message": "DISABLE_SCANNING_MESSAGE"
},
"last_attendee_update_time": {
"utc": "LAST_UPDATE_UTC",
"local": "LAST_UPDATE_LOCAL"
},
"ticket_id": "TICKET_ID",
"order_id": "ORDER_ID",
"attendance_settings": "ATTENDANCE_SETTINGS",
"attendance": []
}
],
"attendance_count": {
"attended": "ATTENDED_COUNT",
"not_attended": "NOT_ATTENDED_COUNT"
},
"pagination": {
"records": "TOTAL_RECORDS",
"position": "CURRENT_POSITION",
"rows": "ROWS_PER_PAGE"
}
}|
Attribute |
Type |
Description |
|---|---|---|
|
tickets |
array |
List of tickets in the response. |
|
tickets[].uuid |
string |
Unique identifier for the ticket. |
|
tickets[].serial |
string |
Serial number of the ticket. |
|
tickets[].codes |
object |
Codes associated with the ticket. |
|
tickets[].codes.type |
string |
Type of the code. |
|
tickets[].codes.value |
string |
Value of the code. |
|
tickets[].codes.image |
string |
Path to the code image. |
|
tickets[].special_instruction |
string |
Special instructions for the ticket. |
|
tickets[].attendee_details |
array |
List of attendee details for the ticket. |
|
tickets[].attendee_details[].uuid |
string |
Unique identifier for the attendee. |
|
tickets[].attendee_details[].attributes |
array |
List of custom attributes for the attendee. |
|
tickets[].attendee_details[].attributes[].field_name |
string |
Name of the custom field. |
|
tickets[].attendee_details[].attributes[].field_type |
string |
Type of the custom field. |
|
tickets[].attendee_details[].attributes[].field_value |
string |
Value of the custom field. |
|
tickets[].product |
object |
Details of the ticket's associated product. |
|
tickets[].product.ticket_name |
string |
Name of the ticket. |
|
tickets[].product.ticket_variation |
string |
Variation of the ticket. |
|
tickets[].product.ticket_description |
string |
Description of the ticket. |
|
tickets[].product.sell_session |
boolean |
Indicates if the session is for sale. |
|
tickets[].product.sessions |
array |
List of sessions associated with the ticket. |
|
tickets[].product.sessions[].session_uuid |
string |
Unique identifier for the session. |
|
tickets[].product.sessions[].session_name |
string |
Name of the session. |
|
tickets[].product.sessions[].session_date |
object |
Date information for the session. |
|
tickets[].product.sessions[].session_date.utc |
string |
Session date in UTC format. |
|
tickets[].product.sessions[].session_date.local |
string |
Session date in local format. |
|
tickets[].order |
object |
Details of the associated order. |
|
tickets[].order.uuid |
string |
Unique identifier for the order. |
|
tickets[].event |
object |
Details of the associated event. |
|
tickets[].event.uuid |
string |
Unique identifier for the event. |
|
tickets[].event.name |
string |
Name of the event. |
|
tickets[].event.display_name |
string |
Display name of the event. |
|
tickets[].event.timezone |
string |
Timezone of the event. |
|
tickets[].event.banner |
array |
List of banners for the event. |
|
tickets[].event.banner[].name |
string |
Name of the banner. |
|
tickets[].event.banner[].image |
string |
Image path of the banner. |
|
tickets[].event.banner[].primary |
boolean |
Indicates if the banner is primary. |
|
tickets[].event.event_starts_on |
object |
Start date and time of the event. |
|
tickets[].event.event_starts_on.utc |
string |
Start date and time in UTC format. |
|
tickets[].event.event_starts_on.local |
string |
Start date and time in local format. |
|
tickets[].event.event_ends_on |
object |
End date and time of the event. |
|
tickets[].event.event_ends_on.utc |
string |
End date and time in UTC format. |
|
tickets[].event.event_ends_on.local |
string |
End date and time in local format. |
|
tickets[].org |
object |
Organisation details for the ticket. |
|
tickets[].org.uuid |
string |
Unique identifier for the organisation. |
|
tickets[].org.name |
string |
Name of the organisation. |
|
tickets[].org.slug |
string |
Slug of the organisation. |
|
tickets[].org.image |
string |
Image URL of the organisation. |
|
tickets[].reference_no |
string |
Reference number for the ticket. |
|
tickets[].invoice_no |
string |
Invoice number for the ticket. |
|
tickets[].seat |
string |
Seat number for the ticket. |
|
tickets[].disable_scanning |
object |
Scanning settings for the ticket. |
|
tickets[].disable_scanning.value |
boolean |
Indicates if scanning is disabled. |
|
tickets[].disable_scanning.message |
string |
Message regarding scanning status. |
|
tickets[].last_attendee_update_time |
object |
Last update time of the attendee details. |
|
tickets[].last_attendee_update_time.utc |
string |
Last update time in UTC format. |
|
tickets[].last_attendee_update_time.local |
string |
Last update time in local format. |
|
tickets[].ticket_id |
string |
ID of the ticket. |
|
tickets[].order_id |
string |
ID of the order. |
|
tickets[].attendance_settings |
string |
Attendance settings for the ticket. |
|
tickets[].attendance |
array |
Attendance records for the ticket. |
|
attendance_count |
object |
Summary of attendance count. |
|
attendance_count.attended |
string |
Number of attendees who attended. |
|
attendance_count.not_attended |
string |
Number of attendees who did not attend. |
|
pagination |
object |
Pagination details. |
|
pagination.records |
string |
Total number of records. |
|
pagination.position |
string |
Current position in the records. |
|
pagination.rows |
string |
Number of rows per page. |
Get Specific Event Ticket: /events/{event_uuid}/tickets/{ticket_uuid}
GET
https://api-rto.eventbookings.com/v3/events/{event_uuid}/tickets/{ticket_uuid}
Try It Out
Purpose
Retrieve detailed information about a specific ticket within an event. This includes ticket details, attendee information, the associated event and product details, as well as attendance records if available.
Scope
event.read_ticket → Tickets view permission must be granted from the application to view ticket.
Use Case
This endpoint can be used by event organisers or system administrators to get comprehensive details about a ticket, including the attendee's information, ticket type, product information, and session details. It helps with managing and tracking tickets for specific events.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uuid | string | The unique identifier of the event to which the ticket belongs. |
| ticket_uuid | string | The unique identifier for the ticket being queried. |
Query Parameters
|
Parameter |
Type |
Allowed Value |
Description |
|---|---|---|---|
|
session_uuid |
uuid |
N/A |
A unique identifier for the session. |
|
position |
number |
N/A |
Specifies the starting position for data retrieval. |
|
rows |
number |
20 to 100 |
Limits the number of rows returned in the response. |
|
occurrence_start_on |
datetime |
yyyy-mm-dd hh:mm |
Specifies the start date and time for occurrences. |
|
order_by |
enum |
created_ascending, created_descending, starting, name_ascending, name_descending |
Defines the sorting order for the response data. |
Request Body
No request body is required for this endpoint.
Response
The response contains detailed ticket information, including the ticket's UUID, serial number, and a QR code image URL. It also includes attendee details such as first name, last name, email, and address (billing and delivery), along with other personal information like mobile number, timezone, and newsletter preferences. Additionally, the response provides product details, including the ticket name, session information (name, date, and time), and order details such as the order UUID and invoice number. Event details are also included, like the event's name, start/end times, timezone, and event banners. Organisation information (name, slug) is provided, and ticket-specific data like attendance settings, seat availability, and scanning permissions are also included. If applicable, the response includes the last attendee update and activity time.
JSON
{
"uuid": "UUID",
"serial": "",
"codes": {
"type": "qr",
"value": "",
"image": "IMAGE_URL"
},
"special_instruction": "",
"attendee_details": [
{
"uuid": "ATTENDEE_UUID",
"attributes": [
{
"field_name": "first_name",
"field_type": "string",
"field_value": "FIRST_NAME"
},
{
"field_name": "last_name",
"field_type": "string",
"field_value": "LAST_NAME"
},
{
"field_name": "preferred_name",
"field_type": "string",
"field_value": "PREFERRED_NAME"
},
{
"field_name": "email",
"field_type": "string",
"field_value": "EMAIL"
},
{
"field_name": "address_line_1",
"field_type": "string",
"field_value": "ADDRESS_LINE_1"
},
{
"field_name": "address_line_2",
"field_type": "string",
"field_value": "ADDRESS_LINE_2"
},
{
"field_name": "address_line_3",
"field_type": "string",
"field_value": "ADDRESS_LINE_3"
},
{
"field_name": "city",
"field_type": "string",
"field_value": "CITY"
},
{
"field_name": "postcode",
"field_type": "string",
"field_value": "POSTCODE"
},
{
"field_name": "state",
"field_type": "string",
"field_value": "STATE"
},
{
"field_name": "country",
"field_type": "string",
"field_value": "COUNTRY"
},
{
"field_name": "dob",
"field_type": "string",
"field_value": "DOB"
},
{
"field_name": "mobile",
"field_type": "string",
"field_value": "MOBILE"
},
{
"field_name": "telephone",
"field_type": "string",
"field_value": "TELEPHONE"
},
{
"field_name": "additional_email",
"field_type": "string",
"field_value": "ADDITIONAL_EMAIL"
},
{
"field_name": "delivery_first_name",
"field_type": "string",
"field_value": "DELIVERY_FIRST_NAME"
},
{
"field_name": "delivery_last_name",
"field_type": "string",
"field_value": "DELIVERY_LAST_NAME"
},
{
"field_name": "delivery_address_line_1",
"field_type": "string",
"field_value": "DELIVERY_ADDRESS_LINE_1"
},
{
"field_name": "delivery_address_line_2",
"field_type": "string",
"field_value": "DELIVERY_ADDRESS_LINE_2"
},
{
"field_name": "delivery_city",
"field_type": "string",
"field_value": "DELIVERY_CITY"
},
{
"field_name": "delivery_postcode",
"field_type": "string",
"field_value": "DELIVERY_POSTCODE"
},
{
"field_name": "delivery_state",
"field_type": "string",
"field_value": "DELIVERY_STATE"
},
{
"field_name": "delivery_country",
"field_type": "string",
"field_value": "DELIVERY_COUNTRY"
},
{
"field_name": "billing_name_title",
"field_type": "string",
"field_value": "BILLING_NAME_TITLE"
},
{
"field_name": "billing_first_name",
"field_type": "string",
"field_value": "BILLING_FIRST_NAME"
},
{
"field_name": "billing_last_name",
"field_type": "string",
"field_value": "BILLING_LAST_NAME"
},
{
"field_name": "billing_address_line_1",
"field_type": "string",
"field_value": "BILLING_ADDRESS_LINE_1"
},
{
"field_name": "billing_address_line_2",
"field_type": "string",
"field_value": "BILLING_ADDRESS_LINE_2"
},
{
"field_name": "billing_city",
"field_type": "string",
"field_value": "BILLING_CITY"
},
{
"field_name": "billing_postcode",
"field_type": "string",
"field_value": "BILLING_POSTCODE"
},
{
"field_name": "billing_state",
"field_type": "string",
"field_value": "BILLING_STATE"
},
{
"field_name": "billing_country",
"field_type": "string",
"field_value": "BILLING_COUNTRY"
},
{
"field_name": "is_newsletter",
"field_type": "boolean",
"field_value": "IS_NEWSLETTER"
},
{
"field_name": "newsletter_types",
"field_type": "string",
"field_value": "NEWSLETTER_TYPES"
},
{
"field_name": "email_sent",
"field_type": "boolean",
"field_value": "EMAIL_SENT"
},
{
"field_name": "is_sync",
"field_type": "boolean",
"field_value": "IS_SYNC"
},
{
"field_name": "image",
"field_type": "string",
"field_value": "IMAGE_URL"
},
{
"field_name": "timezone",
"field_type": "string",
"field_value": "TIMEZONE"
}
]
}
],
"product": {
"ticket_name": "TICKET_NAME",
"ticket_variation": "TICKET_VARIATION",
"ticket_description": "TICKET_DESCRIPTION",
"sell_session": true,
"sessions": [
{
"session_uuid": "SESSION_UUID",
"session_name": "SESSION_NAME",
"session_date": {
"utc": "SESSION_UTC_DATE",
"local": "SESSION_LOCAL_DATE"
}
}
]
},
"order": {
"uuid": "ORDER_UUID"
},
"event": {
"uuid": "EVENT_UUID",
"name": "EVENT_NAME",
"display_name": "EVENT_DISPLAY_NAME",
"timezone": "EVENT_TIMEZONE",
"banner": [
{
"name": "BANNER_NAME",
"image": "BANNER_IMAGE_URL",
"primary": true
}
],
"configuration": [],
"event_starts_on": {
"utc": "EVENT_UTC_START_DATE",
"local": "EVENT_LOCAL_START_DATE"
},
"event_ends_on": {
"utc": "EVENT_UTC_END_DATE",
"local": "EVENT_LOCAL_END_DATE"
}
},
"org": {
"uuid": "ORG_UUID",
"name": "ORG_NAME",
"slug": "ORG_SLUG",
"image": "ORG_IMAGE"
},
"reference_no": "REFERENCE_NO",
"invoice_no": "INVOICE_NO",
"seat": null,
"disable_scanning": {
"value": false,
"message": ""
},
"last_attendee_update_time": {
"utc": "LAST_ATTENDEE_UPDATE_UTC",
"local": "LAST_ATTENDEE_UPDATE_LOCAL"
},
"ticket_id": "TICKET_ID",
"order_id": "ORDER_ID",
"last_attendee_activity_on": "LAST_ATTENDEE_ACTIVITY_DATE",
"attendance_settings": null,
"attendance": []
}|
Attribute |
Type |
Description |
|---|---|---|
|
uuid |
string |
Unique identifier for the |
|
serial |
string |
Serial number associated with the |
|
codes |
object |
Contains QR code details. |
|
codes.type |
string |
Type of code. |
|
codes.value |
string |
Value associated with the code. |
|
codes.image |
string (URL) |
URL of the QR code image. |
|
special_instruction |
string |
Any special instructions related to the |
|
attendee_details |
array |
List of attendee details. |
|
attendee_details.uuid |
string |
Unique identifier for the attendee. |
|
attendee_details.attributes |
array |
List of attributes for each attendee. |
|
attendee_details.attributes[].field_name |
string |
Name of the field. |
|
attendee_details.attributes[].field_type |
string |
Data type of the field. |
|
attendee_details.attributes[].field_value |
string |
Value of the field. |
|
product |
object |
Contains product-related details. |
|
product.ticket_name |
string |
Name of the ticket. |
|
product.ticket_variation |
string |
Variation of the ticket. |
|
product.ticket_description |
string |
Description of the ticket. |
|
product.sell_session |
boolean |
Indicates if the session is sellable. |
|
product.sessions |
array |
List of session details. |
|
product.sessions[].session_uuid |
string |
Unique identifier for the session. |
|
product.sessions[].session_name |
string |
Name of the session. |
|
product.sessions[].session_date |
object |
Contains session date details. |
|
product.sessions[].session_date.utc |
string |
Session date in UTC format. |
|
product.sessions[].session_date.local |
string |
Session date in local format. |
|
order |
object |
Contains order-related details. |
|
order.uuid |
string |
Unique identifier for the order. |
|
event |
object |
Contains event-related details. |
|
event.uuid |
string |
Unique identifier for the event. |
|
event.name |
string |
Name of the event. |
|
event.display_name |
string |
Display name of the event. |
|
event.timezone |
string |
Timezone of the event. |
|
event.banner |
array |
List of event banners. |
|
event.banner[].name |
string |
Name of the banner. |
|
event.banner[].image |
string (URL) |
URL of the banner image. |
|
event.banner[].primary |
boolean |
Indicates if the banner is primary. |
|
event.event_starts_on |
object |
Contains event start date details. |
|
event.event_starts_on.utc |
string |
Event start date in UTC format. |
|
event.event_starts_on.local |
string |
Event start date in local format. |
|
event.event_ends_on |
object |
Contains event end date details. |
|
event.event_ends_on.utc |
string |
Event end date in UTC format. |
|
event.event_ends_on.local |
string |
Event end date in local format. |
|
org |
object |
Contains organisation-related details. |
|
org.uuid |
string |
Unique identifier for the organisation. |
|
org.name |
string |
Name of the organisation. |
|
org.slug |
string |
Slug identifier for the organisation. |
|
org.image |
string (URL) |
URL of the organisation's image. |
|
reference_no |
string |
Reference number for the |
|
invoice_no |
string |
Invoice number for the |
|
seat |
null |
Reserved for future use. |
|
disable_scanning |
object |
Details about scanning settings. |
|
disable_scanning.value |
boolean |
Indicates if scanning is disabled. |
|
disable_scanning.message |
string |
Message related to scanning settings. |
|
last_attendee_update_time |
object |
Contains the last update time for attendees. |
|
last_attendee_update_time.utc |
string |
Update time in UTC format. |
|
last_attendee_update_time.local |
string |
Update time in local format. |
|
ticket_id |
string |
Identifier for the ticket. |
|
order_id |
string |
Identifier for the order. |
|
last_attendee_activity_on |
string |
Last activity date for an attendee. |
|
attendance_settings |
null |
Reserved for future use (currently null). |
|
attendance |
array |
List of attendance details. |
Paginated Responses
A paginated response includes two primary sections: a pagination header and a list of objects. Below is an example of a paginated response:
JSON
"pagination": {
"records": "RECORDS_COUNT",
"position": "POSITION",
"rows": "ROWS_COUNT",
"order_by": "ORDER_BY"
}| Attribute | Type | Description |
|---|---|---|
| records | string | The total number of records available across all pages. |
| position |
string |
The current position in the list of records being viewed. |
| rows |
string |
The number of rows (or items) displayed per page. |
| order_by |
string |
The column and order used to sort the records |