List registration opportunities as slim dropdown options
Purpose-built for filter dropdowns that need every registration opportunity for the tenant: paginates in SQL, selects only the columns an option list renders, and serializes no relations or computed pricing attributes. Prefer this over index() for pickers.
query Parameters
filter[parent_program_id]Filter to registration opportunities under this program.
filter[archived_at]Filter by archived status. Pass empty string to exclude archived registration opportunities.
filter[deleted_at]Filter by deleted status. Pass empty string to exclude deleted registration opportunities.
filter[query]Search registration opportunities by name (partial match).
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
List registration opportunities as slim dropdown options › Responses
Paginated set of RegistrationOpportunityOptionResource
current_pagefromlast_pageper_pagetototalList registration opportunities
Returns a paginated list of registration opportunities with optional filtering.
query Parameters
filter[parent_program_id]Filter by program ID.
filter[status]Filter by status. Supports multiple comma-separated values. Options: active, upcoming, past, ongoing, archived.
filter[query]Search registration opportunities by name (partial match).
filter[with_participants]Filter to only registration opportunities that have participants.
filter[can_register]Filter to only registration opportunities the authenticated user can register for.
filter[upcoming]Filter to only upcoming registration opportunities.
filter[past]Filter to only past registration opportunities.
filter[archived_at]Filter by archived status. Pass empty string to exclude archived registration opportunities.
filter[deleted_at]Filter by deleted status. Pass empty string to exclude deleted registration opportunities.
includeInclude related resources (comma-separated). Options: signups, parentProgram, waitlistSignups, attendanceSheets, occurrences.
appendAppend computed attributes (comma-separated). Options: audience, signup_count.
sortSort results by field. Prefix with - for descending. Options: id, registration_start_date, registration_end_date, event_start_date, event_end_date, created_at.
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
List registration opportunities › Responses
Paginated set of RegistrationOpportunityResource
current_pagefromlast_pageper_pagetototalGet a registration opportunity
path Parameters
programquery Parameters
includeInclude related resources (comma-separated). Options: metadata, prices, prices.membership, prices.plan, prices.schedule_config, signups, parentProgram, waitlistSignups, attendanceSheets, occurrences, recurrenceRule.
appendAppend computed attributes (comma-separated). Options: signup_count.
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Get a registration opportunity › Responses
RegistrationOpportunityResource
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: id, display_order, is_pinned +49 more | |
| type = null |
iddisplay_orderis_pinnednamedescriptionparent_program_idcan_manage_registration_opportunityWhether the current viewer may manage this registration opportunity.
class_limitevent_start_dateevent_end_dateregistration_start_dateregistration_end_dateregistration_open_until_event_startreadable_event_start_datereadable_event_end_datereadable_registration_start_datereadable_registration_end_dateevent_start_timeevent_end_timereadable_event_start_timereadable_event_end_timestatusongoingarchived_atdeleted_atwaitlist_enabledexclude_from_reminder_emailsis_priority_waitlist_lockedmultiple_signupsdisplay_to_all_usershide_from_non_buyersdob_validationmin_date_of_birthDOB at the minimum allowed age (youngest participant) — the latest calendar date in the range.
max_date_of_birthDOB at the maximum allowed age (oldest participant) — the earliest calendar date in the range.
program_pricesfreeignore_gstproduct_idregistration_start_timeregistration_end_timeis_eventprompt_for_registrantprompt_for_number_of_guestsforce_additional_member_infoallow_file_uploadsfile_uploads_requiredfile_uploads_maxpay_by_cashcollect_additional_informationform_idcreated_atupdated_atmember_savingsMember discount savings compared to guest pricing.
price_for_userPrice for the currently authenticated user based on membership status.
num_signups_remaining_for_userNumber of signups remaining for the authenticated user (based on signup limits).
lowest_price_excludedLowest price available excluding special member pricing.
highest_priceHighest price tier available for this registration opportunity.
signup_countTotal number of active signups for this registration opportunity.
is_fullWhether the registration opportunity has reached its capacity limit.
spots_remainingNumber of spots remaining before the registration opportunity is full.
user_signup_countNumber of signups the authenticated user has for this registration opportunity.
volunteer_priceSpecial discounted price for volunteers.
volunteer_price_is_freeWhether the registration opportunity is free for volunteers.
price_id_for_userStripe price ID applicable for the authenticated user.
required_membership_id_for_userStripe product_id the participant must hold for this signup. Populated only when
the program's participant_must_hold_membership toggle is on AND the
participant_membership_enforcement feature flag is on AND the authenticated user
qualifies for a membership-gated price tier. Null in every other case. Gated by
?append=... / ?include=... like the other computed-for-user fields.
price_recurs_for_userWhether the user's price is a recurring subscription.
price_interval_for_userBilling interval for recurring prices (day, week, month, year).
price_interval_count_for_userNumber of intervals between each billing cycle.
can_user_purchaseWhether the authenticated user is eligible to purchase this registration opportunity.
required_membership_namesDistinct membership titles that grant access to purchase this registration opportunity. The field is omitted from the response entirely when the include is not requested; when requested, it is always an array (possibly empty).
signupsSignups registered for this registration opportunity.
parent_programProgram this registration opportunity belongs to.
pricesPricing tiers available for this registration opportunity.
metadatawaiverswaitlist_signupsUsers on the waitlist for this registration opportunity.
attendance_sheetsAttendance sheets for this registration opportunity.
occurrencesDiscrete date/time occurrences for this registration opportunity. Ordered by persisted display position. Admin saves normalize this chronologically.
recurrence_ruleRecurrence pattern that generated this registration opportunity's occurrences,
when the admin authored the schedule via the recurring builder.
Display metadata only — occurrences is the operational source
of truth for queries and registration.