Download OpenAPI specification:
Eventzilla API provides a predictable, resource-oriented way to integrate with Eventzilla and extend it for your event management workflows. API methods use JSON request and response bodies, and responses are returned in JSON format.
Version 2 introduces the core capabilities needed to retrieve Eventzilla account data, prepare and process registrations, confirm or cancel orders, and check in attendees.
To create an API key, sign in to Eventzilla and go to Settings > Developers > API Credentials.
Eventzilla uses an x-api-key header for authentication. Generate an API key by creating an application under Settings > Developers > API Credentials in your Eventzilla account. Keep API keys secret, rotate them when needed, and disable keys that are no longer in use.
All API requests must be sent over HTTPS.
x-api-key: 565e95b08ad5210001000001bf8fe9787f6f4c674f2fd622844adf23
Many list endpoints support filtering by passing returned resource fields as query-string parameters. For example, events can be filtered by status and category.
https://www.eventzillaapi.net/api/v2/events?status=live
https://www.eventzillaapi.net/api/v2/events?status=live&category=music
https://www.eventzillaapi.net/api/v2/events?status=live&offset=0&limit=20&category=music
Endpoints that return multiple records support paging to keep responses fast and predictable.
https://www.eventzillaapi.net/api/v2/events?offset=1&limit=2
| Parameter | Type | Default | Description |
|---|---|---|---|
offset |
integer | 0 |
Number of records to skip before returning results. |
limit |
integer | 20 |
Maximum number of records to return. |
The API uses standard HTTP response codes. A successful request normally returns 200 OK; resource creation may return 201 Created; invalid input may return 400 Bad Request; missing or invalid API keys may return 401 Unauthorized; and a missing resource may return 404 Not Found.
Public endpoints and public response fields should remain backwards compatible. When a clearer field name is introduced, the existing field should continue to be accepted or returned during a deprecation period. New, unreleased endpoints can use the cleaner names directly before they are made public.
Webhook documentation is available on a separate page: View webhook documentation.
Returns events in the authenticated Eventzilla account.
| status | string Filter by event status, such as live, draft, unpublished, or completed. |
| category | string Filter by category name. |
| offset | integer Default: 0 Number of records to skip. |
| limit | integer Default: 20 Maximum number of records to return. |
Array of objects (Pagination) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "pagination": [
- {
- "offset": 0,
- "limit": 20,
- "total": 1
}
], - "events": [
- {
- "id": 2138988852,
- "title": "Chicago SaaS Growth Summit",
- "description": "A one-day conference for SaaS founders, operators, and revenue leaders.",
- "currency": "USD",
- "start_date": "2026-05-20T00:00:00",
- "start_time": "09:00",
- "end_date": "2026-05-20T00:00:00",
- "end_time": "17:00",
- "time_zone": "UTC",
- "tickets_sold": 48,
- "tickets_total": 250,
- "status": "Live",
- "show_remaining": true,
- "twitter_hashtag": "#SaaSGrowthUS",
- "utc_offset": "+00:00",
- "invite_code": "",
- "venue": "McCormick Place, Chicago, IL, USA",
- "dateid": 2138985706,
- "categories": "Business,Conferences,Networking",
- "language": "en",
- "description_html": "<p>A one-day conference for SaaS founders, operators, and revenue leaders.</p>",
- "timezone_code": "UTC"
}
]
}| eventid required | integer Event identifier. |
Array of objects (Event) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "events": [
- {
- "id": 2138988852,
- "title": "Chicago SaaS Growth Summit",
- "description": "A one-day conference for SaaS founders, operators, and revenue leaders.",
- "currency": "USD",
- "start_date": "2026-05-20T00:00:00",
- "start_time": "09:00",
- "end_date": "2026-05-20T00:00:00",
- "end_time": "17:00",
- "time_zone": "UTC",
- "tickets_sold": 48,
- "tickets_total": 250,
- "status": "Live",
- "show_remaining": true,
- "twitter_hashtag": "#SaaSGrowthUS",
- "utc_offset": "+00:00",
- "invite_code": "",
- "venue": "McCormick Place, Chicago, IL, USA",
- "dateid": 2138985706,
- "categories": "Business,Conferences,Networking",
- "language": "en",
- "description_html": "<p>A one-day conference for SaaS founders, operators, and revenue leaders.</p>",
- "timezone_code": "UTC"
}
]
}| eventid required | integer Event identifier. |
| offset | integer Default: 0 Number of records to skip. |
| limit | integer Default: 20 Maximum number of records to return. |
Array of objects (Pagination) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (EventTransaction) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "pagination": [
- {
- "offset": 0,
- "limit": 20,
- "total": 1
}
], - "transactions": [
- {
- "transaction_ref": "20260520145-178028",
- "checkout_id": 2138868785,
- "transaction_date": "2026-05-20T14:20:20",
- "transaction_amount": 198,
- "tickets_in_transaction": 2,
- "event_date": "2026-05-20T09:00:00",
- "transaction_status": "Confirmed",
- "user_id": 42628,
- "event_id": 2138988852,
- "title": "Chicago SaaS Growth Summit",
- "email": "amelia.chen@example.com",
- "buyer_first_name": "Amelia",
- "buyer_last_name": "Chen",
- "promo_code": "",
- "payment_type": "Card",
- "comments": "",
- "transaction_tax": 18,
- "transaction_discount": 0,
- "eventzilla_fee": 5.63
}
]
}| eventid required | integer Event identifier. |
Array of objects (Attendee) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "attendees": [
- {
- "first_name": "Amelia",
- "last_name": "Chen",
- "ticket_type": "Early bird admission",
- "bar_code": "EZ202605200001",
- "is_attended": "No",
- "questions": [
- {
- "questions": "Company",
- "answer": "Northstar SaaS"
}
], - "transaction_ref": "20260520145-178028",
- "id": 2139049165,
- "transaction_date": "2026-05-01T10:15:00",
- "transaction_amount": 99,
- "event_date": "2026-05-20T09:00:00",
- "transaction_status": "Confirmed",
- "user_id": 42628,
- "event_id": 2138988852,
- "title": "Chicago SaaS Growth Summit",
- "email": "amelia.chen@example.com",
- "buyer_first_name": "Amelia",
- "buyer_last_name": "Chen",
- "promo_code": "",
- "payment_type": "Card"
}
]
}Sales on/off notifications
| eventid required | integer Event identifier. |
| status required | boolean true to publish sales, false to unpublish sales. |
| eventstatus | string Resulting event sales status. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "eventid": 2138988852,
- "status": true
}{- "eventstatus": "published"
}Returns the ticket types available for the specified event. This public route remains /events/{eventid}/tickets for backwards compatibility, although the resource is documented as ticket types.
| eventid required | integer Event identifier. |
Array of objects (EventTicketType) Ticket types/categories for the event. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (DonationTicket) Donation ticket options for the event, if any. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "tickets": [
- {
- "id": 2138120411,
- "title": "Early bird admission",
- "quantity_total": 150,
- "price": 99,
- "description": "Discounted admission for early registrations.",
- "sales_start_date": "2026-02-05T00:00:00",
- "sales_start_time": "09:00",
- "sales_end_date": "2026-04-20T00:00:00",
- "sales_end_time": "23:00",
- "group_discount": 0,
- "group_percentage": 0,
- "group_price": 0,
- "additional_instructions": "Please bring a valid photo ID for check-in.",
- "unlock_code": "",
- "ticket_type": "Paid",
- "boxoffice_only": false,
- "is_visible": true,
- "limit_minimum": 1,
- "limit_maximum": 10,
- "allow_partial_payment": false,
- "partial_payment_installments": 0,
- "partial_payment_frequency": "",
- "partial_payment_amount": 0
}
], - "donation": [ ]
}Creates a free ticket type for the specified event. This endpoint is new and should be published under /events/{eventid}/ticket-types rather than the older draft /events/{eventid}/tickets path, which is ambiguous with issued tickets and orders.
| eventid required | integer Event identifier. |
| ticket_type_name required | string Name displayed for this ticket type, such as Early bird admission. |
| quantity_total required | integer Total quantity available for this ticket type. |
| ticket_type_description required | string Public description shown to attendees for this ticket type. |
| sales_start_date required | string Date when sales open for this ticket type. Use the date format supported by the API implementation. Prefer ISO 8601 ( |
| sales_end_date required | string Date when sales close for this ticket type. Prefer ISO 8601 ( |
| sales_start_time required | string Time when sales open for this ticket type. |
| sales_end_time required | string Time when sales close for this ticket type. |
| limit_minimum required | integer Minimum quantity that can be selected in one order. |
| limit_maximum required | integer Maximum quantity that can be selected in one order. |
| is_visible required | boolean Whether this ticket type is visible on the event registration page. |
| boxoffice_only required | boolean Whether this ticket type is available only through box office sales. |
| additional_instructions | string Additional instructions shown to attendees after registration or on their ticket. |
| unlock_code | string Optional code required to unlock a restricted ticket type. |
| ticket_type_id | integer Unique identifier for the ticket type. |
| ticket_type_name | string Name displayed for this ticket type. |
| quantity_total | integer Total quantity available for this ticket type. |
| ticket_type_description | string Public description shown to attendees for this ticket type. |
| sales_start_date | string <date-time> Date and time when sales open for this ticket type. |
| sales_start_time | string Time when sales open for this ticket type. |
| sales_end_date | string <date-time> Date and time when sales close for this ticket type. |
| sales_end_time | string Time when sales close for this ticket type. |
| additional_instructions | string Additional instructions shown to attendees. |
| unlock_code | string Optional code required to unlock a restricted ticket type. |
| boxoffice_only | boolean Whether this ticket type is available only through box office sales. |
| is_visible | boolean Whether this ticket type is visible on the event registration page. |
| limit_minimum | integer Minimum quantity that can be selected in one order. |
| limit_maximum | integer Maximum quantity that can be selected in one order. |
| ticket_type_id | integer Unique identifier for the ticket type. |
| ticket_type_name | string Name displayed for this ticket type. |
| quantity_total | integer Total quantity available for this ticket type. |
| ticket_type_description | string Public description shown to attendees for this ticket type. |
| sales_start_date | string <date-time> Date and time when sales open for this ticket type. |
| sales_start_time | string Time when sales open for this ticket type. |
| sales_end_date | string <date-time> Date and time when sales close for this ticket type. |
| sales_end_time | string Time when sales close for this ticket type. |
| additional_instructions | string Additional instructions shown to attendees. |
| unlock_code | string Optional code required to unlock a restricted ticket type. |
| boxoffice_only | boolean Whether this ticket type is available only through box office sales. |
| is_visible | boolean Whether this ticket type is visible on the event registration page. |
| limit_minimum | integer Minimum quantity that can be selected in one order. |
| limit_maximum | integer Maximum quantity that can be selected in one order. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "ticket_type_name": "Early bird admission",
- "quantity_total": 150,
- "ticket_type_description": "Discounted admission for early registrations.",
- "sales_start_date": "2026-02-05",
- "sales_start_time": "09:00",
- "sales_end_date": "2026-04-20",
- "sales_end_time": "23:00",
- "limit_minimum": 1,
- "limit_maximum": 10,
- "additional_instructions": "Please bring a valid photo ID for check-in.",
- "is_visible": true,
- "boxoffice_only": false,
- "unlock_code": ""
}{- "ticket_type_id": 2138120411,
- "ticket_type_name": "Early bird admission",
- "quantity_total": 150,
- "ticket_type_description": "Discounted admission for early registrations.",
- "sales_start_date": "2026-02-05T00:00:00",
- "sales_start_time": "09:00",
- "sales_end_date": "2026-04-20T00:00:00",
- "sales_end_time": "23:00",
- "additional_instructions": "Please bring a valid photo ID for check-in.",
- "unlock_code": "",
- "boxoffice_only": false,
- "is_visible": true,
- "limit_minimum": 1,
- "limit_maximum": 10
}Updates an existing free ticket type. This endpoint is new and should use ticket_type_id in the route. Use PUT instead of PATCH only if the API requires all ticket type fields to be supplied on every update.
| eventid required | integer Event identifier. |
| ticket_type_id required | integer Ticket type identifier. |
| ticket_type_name required | string Name displayed for this ticket type, such as Early bird admission. |
| quantity_total required | integer Total quantity available for this ticket type. |
| ticket_type_description required | string Public description shown to attendees for this ticket type. |
| sales_start_date required | string Date when sales open for this ticket type. Use the date format supported by the API implementation. Prefer ISO 8601 ( |
| sales_end_date required | string Date when sales close for this ticket type. Prefer ISO 8601 ( |
| sales_start_time required | string Time when sales open for this ticket type. |
| sales_end_time required | string Time when sales close for this ticket type. |
| limit_minimum required | integer Minimum quantity that can be selected in one order. |
| limit_maximum required | integer Maximum quantity that can be selected in one order. |
| is_visible required | boolean Whether this ticket type is visible on the event registration page. |
| boxoffice_only required | boolean Whether this ticket type is available only through box office sales. |
| additional_instructions | string Additional instructions shown to attendees after registration or on their ticket. |
| unlock_code | string Optional code required to unlock a restricted ticket type. |
| ticket_type_id | integer Unique identifier for the ticket type. |
| ticket_type_name | string Name displayed for this ticket type. |
| quantity_total | integer Total quantity available for this ticket type. |
| ticket_type_description | string Public description shown to attendees for this ticket type. |
| sales_start_date | string <date-time> Date and time when sales open for this ticket type. |
| sales_start_time | string Time when sales open for this ticket type. |
| sales_end_date | string <date-time> Date and time when sales close for this ticket type. |
| sales_end_time | string Time when sales close for this ticket type. |
| additional_instructions | string Additional instructions shown to attendees. |
| unlock_code | string Optional code required to unlock a restricted ticket type. |
| boxoffice_only | boolean Whether this ticket type is available only through box office sales. |
| is_visible | boolean Whether this ticket type is visible on the event registration page. |
| limit_minimum | integer Minimum quantity that can be selected in one order. |
| limit_maximum | integer Maximum quantity that can be selected in one order. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "ticket_type_name": "Early bird admission",
- "quantity_total": 200,
- "ticket_type_description": "Discounted admission for early registrations.",
- "sales_start_date": "2026-02-05",
- "sales_start_time": "09:00",
- "sales_end_date": "2026-04-20",
- "sales_end_time": "23:00",
- "limit_minimum": 1,
- "limit_maximum": 10,
- "additional_instructions": "Please bring a valid photo ID for check-in.",
- "is_visible": true,
- "boxoffice_only": false,
- "unlock_code": ""
}{- "ticket_type_id": 2138120411,
- "ticket_type_name": "Early bird admission",
- "quantity_total": 200,
- "ticket_type_description": "Discounted admission for early registrations.",
- "sales_start_date": "2026-02-05T00:00:00",
- "sales_start_time": "09:00",
- "sales_end_date": "2026-04-20T00:00:00",
- "sales_end_time": "23:00",
- "additional_instructions": "Please bring a valid photo ID for check-in.",
- "unlock_code": "",
- "boxoffice_only": false,
- "is_visible": true,
- "limit_minimum": 1,
- "limit_maximum": 10
}Returns the available event categories for the authenticated account.
Array of objects (Category) | |||
Array
| |||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "categories": [
- {
- "category": "Business"
}, - {
- "category": "Conferences"
}, - {
- "category": "Networking"
}, - {
- "category": "Training"
}
]
}Get Events by associated Client
| checkout_id required | integer Checkout identifier. |
| eventid required | integer Event identifier. |
| comments required | string Organizer comments for cancellation. |
| ordercancel | string Order cancellation status message. |
| orderconfirm | string Deprecated Historical documentation typo for cancellation response. Prefer ordercancel. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "checkout_id": 21388601015,
- "eventid": 2138988852,
- "comments": "Cancelled at buyer request."
}{- "ordercancel": "success"
}Get Events by associated Client
| checkout_id required | integer Checkout identifier. |
| eventid required | integer Event identifier. |
| comments required | string Organizer comments for the order action. |
| sendemail | boolean Default: true Whether to send notification emails. |
| orderconfirm | string Order confirmation status message. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "checkout_id": 21388601015,
- "eventid": 2138988852,
- "comments": "Confirmed by organizer.",
- "sendemail": false
}{- "orderconfirm": "success"
}Get events by assoiciated clients (Completed events)
| eventid required | integer Event identifier. |
| dateid required | integer Event date/occurrence identifier. |
Array of objects (PaymentOption) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
Array of objects (CheckoutTicketType) Ticket types available for checkout. Public field name retained as tickettypes. | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
Array of objects (CheckoutQuestion) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| discount_enabled | boolean | ||||||||||||||||||||||
| tax_enabled | boolean | ||||||||||||||||||||||
Array of objects (Tax) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "payment_options": [
- {
- "payment_id": 2138979179,
- "paymentoption_name": "stripe"
}, - {
- "payment_id": 2138979165,
- "paymentoption_name": "Free ticket only"
}
], - "tickettypes": [
- {
- "ticket_type_id": 2138120411,
- "ticket_type_name": "Early bird admission",
- "ticket_type_price": "USD 99.00",
- "ticket_type_min_limit": 1,
- "ticket_type_max_limit": 10,
- "ticket_type_avail_quantity": 102,
- "ticket_type_onsale": true,
- "ticket_type_description": "Discounted admission for early registrations."
}
], - "questions": [
- {
- "question_id": 2138360281,
- "question_type": "txt",
- "question_text": "Company",
- "question_choices": [ ],
- "question_waiver": "",
- "has_subquestion": false,
- "subquestion_rules": [ ]
}
], - "discount_enabled": true,
- "tax_enabled": true,
- "tax": [
- {
- "tax_type": "inclusive",
- "tax_name": "GST",
- "tax_value": "10%"
}
]
}| eventid required | integer Event identifier. | ||||
| eventdateid required | integer Event date/occurrence identifier. | ||||
required | Array of objects (CheckoutCreateTicketTypeRequest) Ticket types and quantities to reserve. | ||||
Array
| |||||
| discount_code | string Discount code, if any. | ||||
| checkout_id | integer Checkout identifier. | ||||||
| transaction_ref | string Transaction reference. | ||||||
| transaction_total | number Transaction total. | ||||||
| transaction_tax | number Tax amount. | ||||||
| transaction_discount | number Discount amount. | ||||||
| transaction_status | string Transaction status. | ||||||
| eventzilla_fee | number Eventzilla fee. | ||||||
Array of objects (CheckoutCreatedTicket) | |||||||
Array
| |||||||
| currency | string Currency symbol or code. | ||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "eventid": 2138988852,
- "eventdateid": 2138985706,
- "ticket_types": [
- {
- "ticket_type_id": 2138120411,
- "quantity": 2
}
], - "discount_code": "SAAS20"
}{- "checkout_id": 21388601015,
- "transaction_ref": "20260520145-178028",
- "transaction_total": 198,
- "transaction_tax": 18,
- "transaction_discount": 0,
- "transaction_status": "Incomplete",
- "eventzilla_fee": 5.63,
- "currency": "USD",
- "tickets": [
- {
- "ticket_price_id": 1362622,
- "ticket_type_id": 2138120411,
- "ticket_type_name": "Early bird admission"
}, - {
- "ticket_price_id": 1362623,
- "ticket_type_id": 2138120411,
- "ticket_type_name": "Early bird admission"
}
]
}| eventid required | integer Event identifier. | ||||||||||||||||
| eventdateid required | integer Event date/occurrence identifier. | ||||||||||||||||
| checkout_id required | integer Checkout identifier. | ||||||||||||||||
required | Array of objects (BuyerDetails) Buyer information. | ||||||||||||||||
Array
| |||||||||||||||||
required | Array of objects (CheckoutFillOrderTicket) Attendee/ticket details. | ||||||||||||||||
Array
| |||||||||||||||||
| payment_id required | integer Payment option identifier. | ||||||||||||||||
| checkout_id | integer Checkout identifier. | ||||||
| transaction_ref | string Transaction reference. | ||||||
| transaction_total | number Transaction total. | ||||||
| transaction_tax | number Tax amount. | ||||||
| transaction_discount | number Discount amount. | ||||||
| transaction_status | string Transaction status. | ||||||
| eventzilla_fee | number Eventzilla fee. | ||||||
Array of objects (CheckoutCreatedTicket) | |||||||
Array
| |||||||
| currency | string Currency symbol or code. | ||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "eventid": 2138988852,
- "eventdateid": 2138985706,
- "checkout_id": 21388601015,
- "buyerdetails": [
- {
- "buyer_firstname": "Amelia",
- "buyer_lastname": "Chen",
- "buyer_email": "amelia.chen@example.com"
}
], - "tickets": [
- {
- "ticket_price_id": 1362622,
- "first_name": "Amelia",
- "last_name": "Chen",
- "email": "amelia.chen@example.com",
- "answers": [
- {
- "question_id": 2138360281,
- "answer_text": "Northstar SaaS"
}
]
}, - {
- "ticket_price_id": 1362623,
- "first_name": "Noah",
- "last_name": "Williams",
- "email": "noah.williams@example.com",
- "answers": [
- {
- "question_id": 2138360281,
- "answer_text": "Northstar SaaS"
}
]
}
], - "payment_id": 2138979179
}{- "checkout_id": 21388601015,
- "transaction_ref": "20260520145-178028",
- "transaction_total": 198,
- "transaction_tax": 18,
- "transaction_discount": 0,
- "transaction_status": "Incomplete",
- "eventzilla_fee": 5.63,
- "currency": "USD"
}| eventid required | integer Event identifier. |
| eventdateid required | integer Event date/occurrence identifier. |
| checkout_id required | integer Checkout identifier. |
| payment_status required | string Payment status for ticket confirmation. |
| comments | string Order confirmation comments. |
| sendemail | boolean Default: true Whether to send the confirmation email. |
| checkout_id | integer Checkout identifier. |
| transaction_ref | string Transaction reference. |
| transaction_total | number Transaction total. |
| transaction_tax | number Tax amount. |
| transaction_discount | number Discount amount. |
| eventzilla_fee | number Eventzilla fee. |
| transaction_status | string Transaction status. |
| confirmation_email_sent | boolean Whether a confirmation email was sent to the buyer. |
| currency | string Currency symbol or code. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "eventid": 2138988852,
- "eventdateid": 2138985706,
- "checkout_id": 21388601015,
- "payment_status": "success",
- "comments": "Payment confirmed.",
- "sendemail": false
}{- "checkout_id": 21388601015,
- "transaction_ref": "20260520145-178028",
- "transaction_total": 198,
- "transaction_tax": 18,
- "transaction_discount": 0,
- "eventzilla_fee": 5.63,
- "transaction_status": "confirmed",
- "confirmation_email_sent": false,
- "currency": "USD"
}| attendeeid required | integer Attendee identifier. |
Array of objects (Attendee) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "attendees": [
- {
- "first_name": "Amelia",
- "last_name": "Chen",
- "ticket_type": "Early bird admission",
- "bar_code": "EZ202605200001",
- "is_attended": "No",
- "questions": [
- {
- "questions": "Company",
- "answer": "Northstar SaaS"
}
], - "refno": "20260520145-178028",
- "id": 2139049165,
- "event_date": "2026-05-20T09:00:00",
- "event_id": 2138988852,
- "transaction_date": "2026-05-01T10:15:00",
- "transaction_amount": 99,
- "transaction_status": "Confirmed",
- "title": "Chicago SaaS Growth Summit",
- "email": "amelia.chen@example.com",
- "buyer_first_name": "Amelia",
- "buyer_last_name": "Chen",
- "payment_type": "Card"
}
]
}Get attendees by associated Client
| barcode required | string Unique barcode from the attendee's ticket. |
required | boolean or string true to check in the attendee, false to revert check-in. |
One of boolean true to check in the attendee, false to revert check-in. | |
| first_name | string Attendee first name. |
| last_name | string Attendee last name. |
| eventtitle | string Event title. |
| orderref | string Order reference. |
| orderef | string Deprecated Historical misspelling of orderref found in examples. |
string <email> Attendee email address. | |
| status | string Check-in or check-out status. |
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "barcode": "EZ202605200001",
- "eventcheckin": true
}{- "first_name": "Amelia",
- "last_name": "Chen",
- "eventtitle": "Chicago SaaS Growth Summit",
- "orderref": "20260520145-178028",
- "email": "amelia.chen@example.com",
- "status": "Checkin"
}| offset | integer Default: 0 Number of records to skip. |
| limit | integer Default: 20 Maximum number of records to return. |
Array of objects (Pagination) | |||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||
Array of objects (User) | |||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "pagination": [
- {
- "offset": 0,
- "limit": 20,
- "total": 1
}
], - "users": [
- {
- "id": 2130004479,
- "username": "events@example.com",
- "first_name": "Maya",
- "last_name": "Patel",
- "company": "Northstar Events",
- "address_line1": "123 Eagle Street",
- "address_line2": "",
- "zip_code": "4000",
- "address_locality": "Chicago",
- "address_region": "IL",
- "address_country": "United States",
- "email": "maya.patel@example.com",
- "timezone": "UTC",
- "phone_primary": "+61 7 3000 1234",
- "avatar_url": "",
- "facebook_id": "",
- "twitter_id": "",
- "last_seen": "2026-05-20T08:21:37",
- "user_type": "organizer"
}
]
}| userid required | integer User/organizer identifier. |
Array of objects (Pagination) | |||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||
Array of objects (User) | |||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "users": [
- {
- "id": 2130004479,
- "username": "events@example.com",
- "first_name": "Maya",
- "last_name": "Patel",
- "company": "Northstar Events",
- "address_line1": "123 Eagle Street",
- "address_line2": "",
- "zip_code": "4000",
- "address_locality": "Chicago",
- "address_region": "IL",
- "address_country": "United States",
- "email": "maya.patel@example.com",
- "timezone": "UTC",
- "phone_primary": "+61 7 3000 1234",
- "avatar_url": "",
- "facebook_id": "",
- "twitter_id": "",
- "last_seen": "2026-05-20T08:21:37",
- "user_type": "organizer"
}
]
}| identifier required | string Checkout ID or order reference number. |
Array of objects (EventTransaction) | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||
| status required | integer HTTP status code. |
| error_code required | string Readable error code. |
| message required | string Detailed error message. |
{- "transaction": [
- {
- "refno": "20260520145-178028",
- "checkout_id": 2138868785,
- "transaction_date": "2026-05-20T14:20:20",
- "transaction_amount": 198,
- "tickets_in_transaction": 2,
- "event_date": "2026-05-20T09:00:00",
- "transaction_status": "Confirmed",
- "user_id": 42628,
- "event_id": 2138988852,
- "title": "Chicago SaaS Growth Summit",
- "email": "amelia.chen@example.com",
- "buyer_first_name": "Amelia",
- "buyer_last_name": "Chen",
- "promo_code": "",
- "payment_type": "Card",
- "comments": "",
- "transaction_tax": 18,
- "transaction_discount": 0,
- "eventzilla_fee": 5.63
}
]
}