EventProducts
Search EventProducts
Search and list EventProduct records with filtering, sorting, and pagination.
GET
Search EventProducts
An EventProduct links a product to a calendar event, allowing products to be sold as part of event registration (e.g. event tickets, catering add-ons).
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the EventProduct-List role.Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
0 for ascending, 1 for descending.Filters
Filter by iD of the calendar event linked to this record.
Filter by the name value for this event product.
Filter by free-text description of this event product.
Filter by the ticket notes value for this event product.
Filter by whether visible is enabled.
Filter by the display order value for this event product.
Filter by date/time value for start date.
Filter by date/time value for end date.
Filter by the allocation value for this event product.
Filter by the max tickets per attendee value for this event product.
Filter by the sales value for this event product.
Filter by unit price amount.
Filter by iD of the currency linked to this record.
Filter by the currency code value for this event product.
Filter by iD of the tax rate linked to this record.
Filter by iD of the financial account linked to this record.
Filter by whether only for contacts is enabled.
Filter by whether only for members is enabled.
Range Filters
Filter by the display order value for this event product greater than or equal to this value.
Filter by the display order value for this event product less than or equal to this value.
Filter by date/time value for start date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date/time value for start date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date/time value for end date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by date/time value for end date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by the allocation value for this event product greater than or equal to this value.
Filter by the allocation value for this event product less than or equal to this value.
Filter by the max tickets per attendee value for this event product greater than or equal to this value.
Filter by the max tickets per attendee value for this event product less than or equal to this value.
Filter by the sales value for this event product greater than or equal to this value.
Filter by the sales value for this event product less than or equal to this value.
Filter by unit price amount greater than or equal to this value.
Filter by unit price amount less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of EventProduct records matching the query. See the Get one EventProduct endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
0 = ascending, 1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search EventProducts