EventBookings API Documentation

Introduction

Welcome to the EventBookings API! Ready to simplify event management? With our API, you can effortlessly handle event listings, attendee registrations, ticketing, payments, and schedules. Dive into this guide and start creating seamless booking experiences today!

Overview

Let’s know about APIs first!

APIs (Application Programming Interfaces) allow applications to work together by requesting features or data without needing to understand the other system's internal details.

The EventBookings API is built on REST principles, using standard HTTP methods like GET, POST, PUT, PATCH and DELETE. All requests are made to the EventBookings API base URL, and responses are returned in JSON format.

Why do we need APIs?

• To help applications share data and features easily.
• To save time by reusing existing tools or services.
• To connect different systems without requiring in-depth knowledge of their inner workings.
• To integrate external services like payments or maps seamlessly into your application.
• To ensure secure and efficient communication between applications.

By combining APIs, developers can quickly build powerful applications without needing to reinvent the wheel.

Key Features

Event Management

• Create Events: Organise single-day or recurring events with full control over event details like title, description, schedule, and venue.
• Update Events: Modify event details anytime, including name, description, timezone, schedules, tickets, and settings.
• Delete Events: Safely remove drafts, canceled events, or events with no orders, ensuring a clutter-free system.
• Organise Sessions: Manage individual sessions within larger events, including start times, topics, and tickets.
• Multi-Organiser Support: Manage multiple organisers within a single account, accommodating different countries and timezones.

Booking Management

• Handle Ticket Bookings: Manage ticket purchases with support for various ticket types, including single, group, and donation tickets with discounts.
• Update Booking Information: Modify billing email addresses and event dates & times as needed.
• Cancel Bookings: Process cancellations for individual attendees or entire orders.
• Order Summaries: Automatically generate detailed order confirmations, including ticket and payment details.

Customisable Event Settings

• Tax Management: Configure tax inclusivity/exclusivity for ticket prices based on your region (applicable for AUS, UK, & NZ).
• Branded QR Codes & Scanning: Generate personalised QR codes for tickets to enable smooth attendee check-ins.

Comprehensive Reporting

• Event Insights: Analyse attendee demographics, ticket sales, and revenue distribution across events.

Base URL

All API requests should be sent to the following base URL:

Public & Private APIs

• Public: Certain APIs are publicly accessible and provide general information. However, sensitive or confidential data is securely protected and can only be accessed by authenticated users.
• Private: These APIs are accessible only to authenticated users, ensuring secure access to protected resources and their respective scopes.

Response Codes

Event Bookings API uses standard HTTP status codes for error handling. Below is a table outlining the status codes, their status, and descriptions:

Each error response includes an error code and a descriptive message to help diagnose issues effectively.

Next Steps

To start using the EventBookings API, follow these steps:

1. Review the Authentication Page: Set up API authentication using a Bearer token.
2. Explore the Available API Endpoints: Find the operations you need.
3. Refer to the Authentication Page: For detailed information on how to authenticate API requests, visit the Authentication Page.