Skip to main content
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

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the calendar event linked to this record.
string
Filter by the name value for this event product.
string
Filter by free-text description of this event product.
string
Filter by the ticket notes value for this event product.
boolean
Filter by whether visible is enabled.
integer
Filter by the display order value for this event product.
string
Filter by date/time value for start date.
string
Filter by date/time value for end date.
integer
Filter by the allocation value for this event product.
integer
Filter by the max tickets per attendee value for this event product.
integer
Filter by the sales value for this event product.
number
Filter by unit price amount.
integer
Filter by iD of the currency linked to this record.
string
Filter by the currency code value for this event product.
integer
Filter by iD of the tax rate linked to this record.
integer
Filter by iD of the financial account linked to this record.
boolean
Filter by whether only for contacts is enabled.
boolean
Filter by whether only for members is enabled.

Range Filters

integer
Filter by the display order value for this event product greater than or equal to this value.
integer
Filter by the display order value for this event product less than or equal to this value.
string
Filter by date/time value for start date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date/time value for start date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date/time value for end date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date/time value for end date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by the allocation value for this event product greater than or equal to this value.
integer
Filter by the allocation value for this event product less than or equal to this value.
integer
Filter by the max tickets per attendee value for this event product greater than or equal to this value.
integer
Filter by the max tickets per attendee value for this event product less than or equal to this value.
integer
Filter by the sales value for this event product greater than or equal to this value.
integer
Filter by the sales value for this event product less than or equal to this value.
number
Filter by unit price amount greater than or equal to this value.
number
Filter by unit price amount less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

EventProduct[]
The list of EventProduct records matching the query. See the Get one EventProduct endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each EventProduct. The following fields are not populated in the Records[] response: Description, TicketNotes, Visible, DisplayOrder, OnlyForContacts, OnlyForMembers.To get all fields, fetch the full record using the Get one EventProduct endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response