EventProducts
Search EventProducts
Search and list EventProduct records with filtering, sorting, and pagination.
GET
Search EventProducts
An Event Product (internally EventProduct) is a purchasable ticket or RSVP option for an event, with its own price, capacity, availability window, and customer-targeting rules.
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 event this ticket belongs to; the event’s location determines the owning location for this record..
string
Filter by required ticket name shown to customers on the Members Portal and app..
string
Filter by optional plain-text description of this ticket shown on the Members Portal and app..
string
Filter by optional plain-text notes appended to the confirmation message sent to customers who purchase this ticket..
boolean
Filter by whether customers can see and purchase this ticket from the Members Portal and app; when false the ticket is hidden from the storefront..
integer
Filter by display position of this ticket among the event’s tickets; lower values appear first..
string
Filter by uTC start of the inclusive window during which this ticket can be purchased; must not be after EndDate..
string
Filter by uTC end of the inclusive window during which this ticket can be purchased; must not be before StartDate..
integer
Filter by maximum number of this ticket type that can be sold; leave empty for no product-specific cap, while the event’s overall capacity still applies..
integer
Filter by maximum number of this ticket a single customer can purchase; leave empty for no per-customer limit..
integer
Filter by read-only ticket sales count maintained by event-attendee data and used when calculating remaining capacity; cannot be set directly..
number
Filter by price charged per ticket in the selected currency; zero makes the ticket free (RSVP only)..
integer
Filter by iD of the ISO 4217 currency used for the ticket price..
string
Filter by display value for Currency.Code..
integer
Filter by optional ID of the tax rate applied when this ticket is invoiced; required when the event’s location requires tax rates..
string
Filter by display value for TaxRate.Name..
integer
Filter by optional ID of the financial account used to record ticket revenue; required when the event’s location requires financial accounts..
string
Filter by display value for FinancialAccount.Name..
boolean
Filter by whether only contacts, meaning customers without an active contract, can purchase this ticket; this combines with every other targeting rule, so setting it with OnlyForMembers makes the ticket unavailable to all customers..
boolean
Filter by whether only members, meaning customers with an active contract, can purchase this ticket; this combines with every other targeting rule, so setting it with OnlyForContacts makes the ticket unavailable to all customers..
string
Filter by read-only comma-separated display names of the plans in the Tariffs collection; change the Tariffs collection instead..
string
Filter by read-only comma-separated display names of the teams in the Teams collection; change the Teams collection instead..
string
Filter by read-only comma-separated display names of the customers in the Members collection; change the Members collection instead..
Range Filters
integer
Filter by display position of this ticket among the event’s tickets; lower values appear first. greater than or equal to this value.
integer
Filter by display position of this ticket among the event’s tickets; lower values appear first. less than or equal to this value.
string
Filter by uTC start of the inclusive window during which this ticket can be purchased; must not be after EndDate. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by uTC start of the inclusive window during which this ticket can be purchased; must not be after EndDate. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by uTC end of the inclusive window during which this ticket can be purchased; must not be before StartDate. greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by uTC end of the inclusive window during which this ticket can be purchased; must not be before StartDate. less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by maximum number of this ticket type that can be sold; leave empty for no product-specific cap, while the event’s overall capacity still applies. greater than or equal to this value.
integer
Filter by maximum number of this ticket type that can be sold; leave empty for no product-specific cap, while the event’s overall capacity still applies. less than or equal to this value.
integer
Filter by maximum number of this ticket a single customer can purchase; leave empty for no per-customer limit. greater than or equal to this value.
integer
Filter by maximum number of this ticket a single customer can purchase; leave empty for no per-customer limit. less than or equal to this value.
integer
Filter by read-only ticket sales count maintained by event-attendee data and used when calculating remaining capacity; cannot be set directly. greater than or equal to this value.
integer
Filter by read-only ticket sales count maintained by event-attendee data and used when calculating remaining capacity; cannot be set directly. less than or equal to this value.
number
Filter by price charged per ticket in the selected currency; zero makes the ticket free (RSVP only). greater than or equal to this value.
number
Filter by price charged per ticket in the selected currency; zero makes the ticket free (RSVP only). 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.
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