List programs as slim dropdown options
Purpose-built for filter dropdowns that need every program for the tenant: paginates in SQL, selects only the columns an option list renders, and serializes no relations (tags, registration opportunities, occurrences). Prefer this over index() for pickers.
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 programs as slim dropdown options › Responses
Paginated set of ParentProgramOptionResource
current_pagefromlast_pageper_pagetototalList programs
Returns a paginated list of programs. Registration opportunities (sessions) are
excluded by default for performance - use ?include=programs to include them.
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 programs › Responses
Paginated set of Program
current_pagefromlast_pageper_pagetototalCreate program
Create a top-level program. Requires the parent-programs:create API key scope and a Program Manager or Super Admin role. Programs default to draft; an omitted, null, or blank title defaults to New Program. Registration opportunities, schedules, and prices are not created.
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Create program › Request Body
titledescriptionongoingevent_start_dateevent_end_dateprofile_imagelocation_namelocation_addresslocation_latitudelocation_longitudepay_by_cashcollection_additional_informationrequire_emergency_contact_informationwaitlist_enabledprompt_for_registrantunsplash_author_nameunsplash_author_linkdemographicinstructorforce_participant_selectiondisplay_onlydraftregistration_feecap_registration_feeis_eventmultiple_signupsis_hiddenshow_participant_listhide_participant_detailstotal_spotsallow_file_uploadsfile_uploads_requiredfile_uploads_maxauto_archiveauto_archive_daysparticipant_must_hold_membershipgl_codeCreate program › Responses
ParentProgram
idtenant_idtitledescriptionlimitdemographicinstructorlocation_namelocation_addresslocation_latitudelocation_longitudeis_onlineregistration_start_dateregistration_end_dateevent_start_dateevent_end_dateprofile_imageunsplash_author_nameunsplash_author_linkmultiple_signupspay_by_cashcollection_additional_informationprompt_for_number_of_guestsprompt_for_registrantwaitlist_enabledcreated_atupdated_atdeleted_atarchived_atblock_facility_calendarsauto_archiveauto_archive_daysparticipant_must_hold_membershipongoingdraftrequire_emergency_contact_informationregistration_feeforce_participant_selectionis_eventform_iddisplay_onlyis_hiddenshow_participant_listhide_participant_detailstotal_spotscap_registration_feeallow_file_uploadsfile_uploads_requiredfile_uploads_maxsort_ordermanual_order_enabledgl_codeavailable_spotsdatesdays_until_eventevent_end_timeevent_start_timefacility_idsignores_tax_ratesreadable_event_end_datereadable_event_start_dateregistration_datesregistration_end_timeregistration_start_timestatusvolunteer_opportunities_idsreserved_spotsreserved_spots_remainingreserved_spots_signupstotal_signupsuncapped_spotsuncapped_spots_remaininguncapped_spots_signupsGet a program
Returns detailed information about a specific program including
all configuration fields. Use ?include=programs to include registration
opportunities (sessions) with pricing information.
path Parameters
parent_programHeaders
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 program › Responses
Program
idUnique identifier for the program.
titleDisplay name of the program shown to users.
descriptionDetailed description of the program, may contain HTML.
event_start_dateWhen the program's events begin. All registration opportunities run within this window.
event_end_dateWhen the program's events end. All registration opportunities run within this window.
registration_start_dateWhen registration opens for this program. Users cannot sign up before this date.
registration_end_dateWhen registration closes for this program. Users cannot sign up after this date.
ongoingWhether this is an ongoing program with no fixed end date.
statusCurrent status of the program (e.g. Active, Archived, Draft, Upcoming, Ongoing, Past, dates_not_set when no aggregate event window exists).
datesHuman-readable formatted event date range for display.
registration_datesHuman-readable formatted registration date range for display.
is_eventWhether this program represents a single event rather than a series of registration opportunities.
draftWhether this program is in draft mode and not yet published.
is_hiddenWhether this program is hidden from public listings.
profile_imageURL to the program's profile/header image.
limitLegacy capacity limit alias retained for compatibility with existing clients.
total_spotsTotal number of signup spots across all registration opportunities.
available_spotsNumber of remaining spots available to be claimed.
total_signupsTotal active signups across registration opportunities.
reserved_spotsNumber of spots reserved by capped registration opportunities.
reserved_spots_signupsNumber of signups currently consuming reserved spots.
reserved_spots_remainingRemaining reserved spots after reserved signups are counted.
uncapped_spotsNumber of spots available to uncapped registration opportunities.
uncapped_spots_signupsNumber of signups currently consuming uncapped spots.
uncapped_spots_remainingRemaining uncapped spots after uncapped signups are counted.
demographicAudience demographic label for this program.
instructorInstructor or facilitator name shown for this program.
location_nameOptional display name for the physical location.
location_addressOptional street address for the location.
Latitude for map display when a location is set.
Longitude for map display when a location is set.
is_onlineWhether the program is delivered online.
readable_event_start_dateHuman-readable event start date in tenant timezone.
readable_event_end_dateHuman-readable event end date in tenant timezone.
event_start_timeEvent start time in tenant timezone (24-hour HH:mm).
event_end_timeEvent end time in tenant timezone (24-hour HH:mm).
registration_start_timeRegistration open time in tenant timezone (24-hour HH:mm).
registration_end_timeRegistration close time in tenant timezone (24-hour HH:mm).
display_onlyWhether this program is display-only and not intended for signup.
unsplash_author_nameUnsplash credit author name for the selected profile image.
unsplash_author_linkUnsplash credit URL for the selected profile image author.
multiple_signupsWhether users may submit multiple signups for this program.
prompt_for_number_of_guestsWhether checkout prompts for number of guests.
prompt_for_registrantWhether checkout prompts for registrant selection.
waitlist_enabledWhether waitlist functionality is enabled for this program.
force_participant_selectionWhether participants must be selected before checkout.
show_participant_listWhether participants can view the participant list for this program.
hide_participant_detailsWhether enrollment counts, participant avatars, and spots remaining are hidden on the program page.
pay_by_cashWhether this program allows cash payment option.
registration_feeRegistration fee amount in minor currency units (for example, cents).
cap_registration_feeWhether registration fee is applied once per checkout instead of per signup.
ignores_tax_ratesWhether this program is configured to ignore tenant tax rates.
collection_additional_informationWhether additional signup form data should be collected.
require_emergency_contact_informationWhether emergency contact information is required at signup.
block_facility_calendarsWhether facility calendars should be blocked by this program.
auto_archiveWhether registration opportunities under this program are automatically archived after their event dates pass.
auto_archive_daysNumber of days after event_end_date to wait before auto-archiving (0 = immediately).
participant_must_hold_membershipWhether the selected participant for a signup must hold the membership that gates the chosen price tier.
form_idOptional linked form identifier for additional questions.
allow_file_uploadsWhether registrants are allowed to upload files during signup.
file_uploads_requiredWhether at least one file upload is required at signup.
file_uploads_maxMaximum number of files allowed per signup, or null for default behavior.
volunteer_opportunities_idsVolunteer opportunity identifiers linked to this program.
facility_idsFacility identifiers linked to this program.
sort_orderDisplay order for sorting in listings.
manual_order_enabledWhether this item is pinned in the recommended sort order.
gl_codeGL code for accounting/financial reporting on program transactions.
created_atWhen this record was created.
updated_atWhen this record was last updated.
deleted_atWhen this record was soft deleted, null if not deleted.
archived_atWhen this program was archived, null if not archived.
facilitiesFacilities/locations where this program takes place.
registration_opportunitiesRegistration opportunities available for registration under this program.
member_pricing_savingsBest currently available member pricing savings versus guest pricing.
volunteer_opportunitiesVolunteer opportunities associated with this program.
waiver_assignmentsWaiver assignments associated with this program.
tags