API v1 Reference

Events

NOTE: The Events API is only supported for legacy events. Click here to learn more about legacy vs. new events.

The Events API deals primarily with three data types: Events, Event Attendees, and Event Registrants.

Events

An event, its properties, and its statistics can be retrieved using the List Events API method.

Event Registrants

An Event Registrant is the individual or organization account who registered (paid) for an event registration. They may or may not be an Attendee. Registrants cannot be retrieved directly through the API, though their account may be accessed indirectly by getting a list of registrants’ account IDs using the Retrieve Event Attendees API method.

Event Attendees

Attendees are the people who are actually attending an event. They differ from Event Registrants in two ways:

  • They may or may not be accounts. Some events (depending on the event configuration) store attendees as accounts. Some events store attendees as attendee records that are not accounts.
  • There may be many attendees per registrant.

Attendees may be retrieved directly through the API using the Retrieve Event Attendees method.

Related Data Types

Events are related to and dependent on several other data types in NeonCRM, as demonstrated in this diagram:

event-relationships