How can we help?
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. | MANDATORY |
| slug | string | Attendee slug. | READ-ONLY |
| permalink | string | Attendee permalink. | READ-ONLY |
| date_created | string | The date when attendee was created, in the site’s timezone | READ-ONLY |
| date_modified | string | The date when the attendee was last modified, in the site’s timezone. | READ-ONLY |
| status | string | The status of attendee ex. Publish, draft etc. | READ-ONLY |
| featured | string | This would be blank for an attendee. | READ-ONLY |
| description | string | This would be blank for an attendee. | MANDATORY |
| avatar | array | Attendee avatar image url | |
| meta_data | array | Meta data. | |
| _links | array | API URL to get individual event data | READ-ONLY |
Attendee – Metadata properties
| Attribute | Type | Description |
|---|---|---|
| id | integer | Meta ID.READ-ONLY |
| key | string | Meta key. |
| value | string | Meta value. |
Get Attendee
This API helps you to view all the attendees of a particular event.
HTTP request
Method : GET
URL : wp-json/wpem/events/<event_id>/attendees/
Method : GET
URL : wp-json/wpem/events/<event_id>/attendees/
Available parameters
| Parameter | Type | Description |
|---|---|---|
| search | string | Limit results to those matching a string. |
| starts_with | string | Limit results to those matching a string. |
Delete an attendee
This API helps you to delete an attendee .
HTTP request
Method : DELETE
URL : /wp-json/wpem/events/<event_id>/attendees/<attendee_id>/notes
Method : DELETE
URL : /wp-json/wpem/events/<event_id>/attendees/<attendee_id>/notes
Available parameters
| Parameter | Type | Description |
|---|---|---|
| force | string | Use true whether to permanently delete the coupon, Default is false . |
Attendee Check-in
This API helps you to checkin an attendee.
HTTP request
Method : POST
URL : /wp-json/wpem/events/<event_id>/attendees/<attendee_id>/checkin
Method : POST
URL : /wp-json/wpem/events/<event_id>/attendees/<attendee_id>/checkin
Available parameters
| Parameter | Type | Description |
|---|---|---|
| force | string | Use true whether to permanently delete the coupon, If this would be false then attendee will checkout. |
| checkin_source | string | Checkin source name(app, web) |
| checkin_device_id | string | Checkin device-id |
| checkin_device_name | string | Checkin device name |