CMS Tool API

CMS Tool API schema

Public API version 1.4.10.

/api/eventAttendee

Read and update event attendees.

GET

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

Query parameters

NameTypeExampleNotes
idint123Filter results by id.
eventidint123Filter results by eventid.
attendeenametextexampleFilter results by attendeename.
attendeestatustextexampleFilter results by attendeestatus.
includeEventInfobooleantrueInclude event info in the response. Accepts true or 1.
offsetint123Skip this many matching records before returning results.
pageSizeint123Limit the number of records returned.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

NameTypeExampleNotes
idint123Set the id value.
eventidint123Set the eventid value.
attendeenametextexampleSet the attendeename value.
attendeestatustextexampleSet the attendeestatus value.
attendeembridint123Set the attendeembrid value.
mbr_emailtextcustomer@example.comSet the mbr email value.

/api/eventAttendee/statusMetaData

Read available attendee statuses.

GET

Read available attendee statuses.

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.