How can we help?
Events
The events API allows you to view and delete individual, or a batch, of events.
Event properties
| Attribute | Type | Description | Permission |
|---|---|---|---|
| id | int | Unique identifier for the object. | READ-ONLY |
| name | string | Event name. | MANDATORY |
| slug | string | Event slug. | READ-ONLY |
| permalink | string | Url of Event for web page. | READ-ONLY |
| date_created | string | The date the event was created, in the site’s timezone. | READ-ONLY |
| date_modified | string | The date the event was last modified, in the site’s timezone. | READ-ONLY |
| status | string | The status of event ex. Publish, draft etc. | |
| featured | string | Event is featured or not (value would be 0 or 1). | |
| description | string | Event description. | MANDATORY |
| event_categories | array | List of category IDs the event applies to. | |
| event_types | array | List of type IDs the event applies to. | |
| event_tags | array | List of tag IDs the event applies to.(If wpem-event-tags plugin is activated) | |
| images | string | Event banner image URL | |
| meta_data | array | Meta data | |
| registrations | array | Registration detail of the event | |
| sell_tickets | array | Ticket sales detail | |
| _links | array | API URL to get individual event data | READ-ONLY |
Event – Metadata properties
| Attribute | Type | Description |
|---|---|---|
| id | integer | Meta ID.READ-ONLY |
| key | string | Meta key. |
| value | string | Meta 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/
URL : wp-json/wpem/events/
Available parameters
| Parameter | Type | Description |
|---|---|---|
| search | string | Limit results to those matching a string. |
| status | string | Limit 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>
Method : DELETE
URL : wp-json/wpem/events/<id>
Available parameters
| Parameter | Type | Description |
|---|---|---|
| force | string | Use true whether to permanently delete the coupon, Default is false. |