Skip to main content
The Events endpoints give you access to LatePoint’s events module: events and their dates, event categories, registrations, and the LatePoint Pro e-tickets and waiting list. All Events endpoints live under /wp-json/latepoint-api/v1/events and use the same authentication and response format as the rest of the API.

Requirements

  • LatePoint 5.7 or newer. On older versions every Events endpoint returns 503 feature_not_available.
  • “Enable Events” setting. Write operations (create, update, delete, cancel, check-in and waiting list actions) return 503 feature_disabled when Events is turned off in LatePoint settings. Read operations keep working.
  • LatePoint Pro Features for ticket types, e-tickets and the waiting list (see Pro features).

Endpoints

Dates and times

Event dates and times follow one rule:
  • Request values and the response fields start, end, registration_start and registration_end are in the site timezone (the timezone configured in WordPress), formatted as YYYY-MM-DD HH:MM. Seconds are optional, and a date alone (YYYY-MM-DD) means 00:00.
  • Fields ending in _utc (start_utc, end_utc) are in UTC.
  • Every event includes a timezone field with the site timezone name, for example America/Montevideo.
An event can have several dates (for example a two-day retreat). The event’s overall start and end are calculated from its dates: start is the earliest date start and end is the latest date end. They are recalculated every time a date is added, changed or removed.
The created_after and created_before filters of List Registrations are an exception: they compare against the stored created_at value and are expressed in UTC (YYYY-MM-DD HH:MM:SS).

Registrations

Registrations are created by customers through LatePoint’s booking form and checkout, not through the API. The API lets you read registrations and cancel them. Cancelling a registration works like the Cancel action in the LatePoint admin. It does not cancel or refund the order the registration belongs to. Manage the order separately with the Orders and Payments endpoints. Order items for events have variant: "event_registration". Get Order includes the related registration in each of those items.

Pro features

Some event features come from LatePoint Pro Features and must also be enabled in LatePoint settings: Pro fields are only included in event responses when the feature is enabled, and Pro request fields are ignored when it is not. Pro endpoints return one of these errors when the feature is unavailable:

Availability Errors

Event Object

integer
Unique identifier for the event
string
Event name
string
URL slug
string
Short summary
string
Full description (HTML)
string
One of draft, published, cancelled, completed
string
in_person or online
string
Meeting URL for online events
integer
Event category ID, or null
object
Category summary (id, name), or null
WordPress media attachment ID of the featured image, or null
Featured image URL, or null
string
Location shown for the event
string
Organizer shown for the event
number
Price per ticket (0 = free)
string
Price formatted with the site currency
boolean
Whether the event is paid
boolean
Whether the price is multiplied by the number of tickets
boolean
Whether the booking form asks for a ticket quantity
string
Overall start, site timezone
string
Overall end, site timezone
string
Overall start, UTC
string
Overall end, UTC
string
When registration opens, site timezone. null = opens immediately
string
When registration closes, site timezone. null = closes when the event starts
boolean
Whether registration is currently open
object
Capacity summary
string
Site timezone name
integer
Display order
string
Creation timestamp
string
Last update timestamp
array
Event dates (id, event_id, start, end, start_utc, end_utc). Only included when getting a single event.
boolean
Pro. Whether the event sells ticket types. Only present when Ticket Types is enabled.
array
Pro. Ticket types (id, event_id, name, price, formatted_price, capacity, booked, available, sold_out, status, order_number). A capacity or available of null means unlimited. Only present when Ticket Types is enabled.
object
Pro. Waiting list settings: enabled, capacity (null = unlimited) and queue_count (people currently in the queue). Only present when Waiting List is enabled.