Events

Events

The events API allows you to view and delete individual, or a batch, of events.

Event properties

AttributeTypeDescriptionPermission
idintUnique identifier for the object.READ-ONLY
namestringEvent name.MANDATORY
slugstringEvent slug.READ-ONLY
permalinkstringUrl of Event for web page.READ-ONLY
date_createdstringThe date the event was created, in the site’s timezone.READ-ONLY
date_modifiedstringThe date the event was last modified, in the site’s timezone.READ-ONLY
statusstringThe status of event ex. Publish, draft etc.
featuredstringEvent is featured or not (value would be 0 or 1).
descriptionstringEvent description.MANDATORY
event_categoriesarrayList of category IDs the event applies to.
event_typesarrayList of type IDs the event applies to.
event_tagsarrayList of tag IDs the event applies to.(If wpem-event-tags plugin is activated)
imagesstringEvent banner image URL
meta_dataarrayMeta data
registrationsarrayRegistration detail of the event
sell_ticketsarrayTicket sales detail
_linksarrayAPI URL to get individual event dataREAD-ONLY

Event – Metadata properties

AttributeTypeDescription
idintegerMeta ID.READ-ONLY
keystringMeta key.
valuestringMeta value.

List all events

This API helps you to list all the events that have been created.

HTTP request
Method : GET
URL : wp-json/wpem/events/

Available parameters

ParameterTypeDescription
searchstringLimit results to those matching a string.
statusstringLimit results to those matching a status.

Delete an event

This API helps you to delete an event.

HTTP request
Method : DELETE
URL : wp-json/wpem/events/<id>

Available parameters

ParameterTypeDescription
forcestringUse true whether to permanently delete the coupon, Default is false.

    • Related Articles

    • Scan QRCode

      The scan QRCode API allows you to scan QRCode of tickets of attendees. Scan QRCode properties Attribute Type Description Permission message string Message for attendee ticket scan READ-ONLY event_title string Event name. attendee_name string Attendee ...
    • Attendee Note

      The attendee note API allows you to view, add and delete an attendee note. Attendee Note properties Attribute Type Description Permission id integer Unique identifier for the resource. READ-ONLY note string Attendee Note. MANDATORY date_created ...
    • Attendee

      The attendee API allows you to view, checkin, checkout and delete an individual, or a batch, of attendee. Attendee properties Attribute Type Description Permission id integer Unique identifier for the object. READ-ONLY name string Attendee name. ...
    • Event Tickets

      The event ticket API allows you to view event ticket information. Event ticket properties Attribute Type Description Permission id integer Unique identifier for the object. READ-ONLY name string Event ticket name. MANDATORY slug string Event ticket ...
    • Event Orders

      The event orders API allows you to view particular event orders information. Order properties Attribute Type Description Permission id integer Unique identifier for the object. READ-ONLY parent_id integer Parent order ID. number string Order number. ...