v1

latestOpenAPI 3.0.02026-08-0630844.5 KB

get/events

Query parameters

pageinteger

The archive page to return

per_pageinteger

The number of events to return on each page

start_datestring

Events that start on the specified date

end_datestring

Events that end on the specified date

starts_beforestring

Events that start before the specified date

starts_afterstring

Events that start after the specified date

ends_beforestring

Events that end before the specified date

ends_afterstring

Events that end after the specified date

strict_datesstring

Dates set using the start_date/end_date, starts_/ends_ are set to start at the specified times. The default behavior is to include the entire days.

searchstring

Events should contain the specified string in the title or description

categoriesinteger[]

Events should be assigned one of the specified categories slugs or IDs

tagsinteger[]

Events should be assigned one of the specified tags slugs or IDs

venueinteger[]

Events should be assigned one of the specified venue IDs

organizerinteger[]

Events should be assigned one of the specified organizer IDs

featuredboolean

Events should be filtered by their featured status

statusstring

The event post status

geolocboolean

Requires Events Calendar Pro. Events should be filtered by whether their venue has geolocation data

geoloc_latnumber

Requires Events Calendar Pro. Events should be filtered by their venue latitude location, must also provide geoloc_lng

geoloc_lngnumber

Requires Events Calendar Pro. Events should be filtered by their venue longitude location, must also provide geoloc_lat

includeinteger[]

Include events with one of the post IDs specified in the array of CSV list, date filters will be ignored.

post_parentinteger

Events should be filtered by their post_parent being the specified one.

ticketedboolean

Filter events with or without tickets.

Response

Returns all the upcoming events matching the search criteria

idinteger

The event WordPress post ID

global_idstring

The event ID used to globally identify in Event Aggregator

global_id_lineagestring[]

An Array containing the lineage of where this event comes from, this should not change after the event is created.

authorinteger

The event author WordPress post ID

datestring

The event creation date in the site time zone

date_utcstring

The event creation date in UTC time

modifiedstring

The event last modification date in the site time zone

modified_utcstring

The event last modification date in UTC time

statusstring

The event status

urlstring

The URL to the event page

rest_urlstring

The TEC REST API link to fetch this event

titlestring

The event name

descriptionstring

The event long description

excerptstring

The event short description

slugstring

The event slug

all_dayboolean

Whether or not this event is an all day Event

start_datestring

The event start date in the event or site time zone

end_datestring

The event end date in the event or site time zone

utc_start_datestring

The event start date in UTC time

utc_end_datestring

The event end date in UTC time

timezonestring

The event time zone string

timezone_abbrstring

The abbreviated event time zone string

coststring

The event cost including the currency symbol

websitestring

The event website URL

show_mapboolean

Whether the map should be shown for the event or not

show_map_linkboolean

Whether the map link should be shown for the event or not

hide_from_listingsboolean

Whether an event should be hidden from the calendar view or not

stickyboolean

Whether an event is sticky in the calendar view or not

featuredboolean

Whether the event is featured in the calendar or not