CMS Tool API schema

Public API version 1.4.51.

Events

Events have a start/end date and additional information, they might be bookable, or just for informational purposes

Endpoint URL

https://api.cms-tool.net/api/event

`/api/events`

Read and update events.

GET

List records, or retrieve one by appending its ID to the path.

Query parameters

Name	Type	Example	Notes
`id`	int	`123`	Filter results by id.
`page`	int	`123`	Filter results by page.
`keywords`	text	`example`	Filter results by keywords.
`eventtitle`	text	`example`	Filter results by eventtitle.
`offset`	int	`123`	Skip this many matching records before returning results.
`pageSize`	int	`123`	Limit the number of records returned; accepted values are 1 through 999, with 200 used otherwise.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

Name	Type	Example	Notes
`id`	int	`123`	Set the id value.
`page`	int	`123`	Set the page value.
`eventtitle`	text	`example`	Set the eventtitle value.
`eventstartdate`	date	`2026-09-24T14:30:00+12:00`	Set the eventstartdate value.
`eventenddate`	date	`2026-09-24T14:30:00+12:00`	Set the eventenddate value.
`eventvenue`	text	`example`	Set the eventvenue value.
`eventcapacity`	int	`123`	Set the eventcapacity value.
`eventsummary`	text	`example`	Set the eventsummary value.

Data definitions

Field	Type	Description
`eventcapacity`	int	Maximum number of attendees. 9999 when no limit is set.
`eventid`	serial	Unique event ID.
`eventattendeecnt`	int	Places taken so far: the sum of attendeecount for attendees with status Booked, Paid, Tentative or Standby. Maintained by the system.
`eventurl`	text	URL of further information or an attachment for the event.
`eventtakebookings`	char	Set when the event accepts bookings. Shows a Book Event link.
`event_notes_question`	text	Prompt for the attendee's free text comments when booking. The answer is saved in attendeenote.
`eventresults`	text	Results of the event, published after it has finished.
`eventauthorid`	int	Member ID of the member who submitted the event through the members' my events page.
`eventenddate`	date	Last day of the event, yyyy-mm-dd. Blank for an event with no end date.
`eventtimezone`	text	Time zone that eventstarttime and eventendtime are in, eg Pacific/Auckland.
`event_fulltext`	text	Full description of the event, shown on the event page.
`eventstartdate`	date	First day of the event, yyyy-mm-dd.
`parenteventid`	int	ID of the original event when this event was created as a repeat (daily, weekly etc) of it.
`event_privacy`	int	Who may see the event: 0 or blank public, 100 anyone logged in, 200 authorised members, 300 authorised members level 2, 999 no one (blocked).
`eventwebinarconnectcomments`	text	Connection notes for the online event, included in booking reminders.
`eventtakebookingsuntil`	interval	How long before the event bookings close: 00:00:01 (last minute, until the event ends), 00:01:00 (until the event starts), 1 day, 2 days, 3 days or 7 days. Blank means no bookings.
`eventendtime`	time	Time of day the event finishes, in eventtimezone.
`eventsresultsurl`	text	URL of a results page or file for the event, up to 200 characters.
`event_enquiry_form`	text	When to show the enquiry form: Always, or Full (only when the event is full or closed). Blank shows no enquiry form.
`eventpid`	int	ID of the product on the same shopping page that is sold when someone books the event.
`eventwebinarurl`	text	Link to join the event online, included in booking reminders.
`event_booking_layout`	text	Booking form layout for the event product: Single (single contact) or Multiple (multiple variant quantities).
`eventonly1day`	text	Regular day of the week for a recurring meet up with a single booking: Monday to Sunday, Weekdays, Weekends or Mon-Sat. Blank means all days in the date range.
`eventquestiona`	text	Optional extra question asked of each attendee when booking. The answer is saved in attendeeanswera.
`eventtimestamp`	timestamp	Date and time the event was last changed. Used to find new or changed events for web digest emails.
`eventquestionc`	text	Optional extra question asked of each attendee when booking. The answer is saved in attendeeanswerc.
`eventquestionb`	text	Optional extra question asked of each attendee when booking. The answer is saved in attendeeanswerb.
`eventtitle`	text	Title of the event.
`eventimg`	text	Photo or image for the event.
`eventvenuepublic`	char	1 to make the venue information public.
`eventtype`	text	Comma separated event categories, eg Blue,Big.
`page`	int	Events page (page.page) the event is listed on.
`eventvenue`	int	ID of the venue where the event is held.
`eventsummary`	text	Short summary shown in event lists and search results.
`eventstarttime`	time	Time of day the event starts, in eventtimezone.
`eventemail`	text	Contact email address for notifications and enquiries about the event.

Usage instructions and examples

Create a new event

To create a new event use POST method and do not provide any Event Id.

Example:

{

"eventtitle" : "New Year Event",

"eventsummary": "Summary of the event..",

"eventstartdate" : "2019-12-31",

"eventedndate" : "2020-01-01",

"page": 123

}

Update en existing event

You can also update an existing event's details. You must include an Event Id. The rest of the parameters provided will be used to update the event.

Example:

{ 
   "id":123,
   "eventtitle":"eventtitle" : "The event title has been changed" ...
}

Sample object

{

   "eventcapacity": 9999,

   "eventid": 1234,

   "eventattendeecnt": 0,

   "eventtakebookingsuntil": "00:00:01",

   "eventendtime": "10:00:00",

   "event_enquiry_form": "Always",

   "eventpid": 0,

   "eventwebinarurl": "https://webinarurl.com",

   "site_search_keywords": "^webinar",

   "eventauthorid": 0,

   "eventenddate": "2021-11-10",

   "eventtimestamp": "2021-09-14 11:52:00.0",

   "eventtitle": "Webinar event",

   "eventstartdate": "2021-11-10",

   "parenteventid": 0,

   "event_privacy": 0,

   "id": 1234,

   "page": 111,  

   "eventvenue": 0,

   "eventstarttime": "09:00:00",

   "cid": 222

}

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.