List program signups
query Parameters
filter[program_id]Filter by registration opportunity ID. Supports comma-separated values for multiple registration opportunities.
filter[program[parent_program_id]]Filter by program ID. Returns signups for all registration opportunities under this program.
filter[user_id]Filter by user ID. Non-managers can only filter to their own ID.
filter[query]Search by registration opportunity name, user name, user email, guest name, additional member name, or guest email.
filter[status]Filter by registration opportunity time status. Supports multiple comma-separated values. Options: ongoing, upcoming, past.
filter[signup_status]Manager-only signup lifecycle filter. Options: active, cancelled, cancelled:member, cancelled:admin. Defaults to active.
filter[timeScope]Simple time scope filter. Options: upcoming (includes ongoing and active), past, all.
filter[event_start_date]Filter by registration opportunity event date range. Pass as array: filter[event_start_date][0]=start&filter[event_start_date][1]=end. Includes ongoing registration opportunities.
filter[upcoming]Filter to signups for upcoming registration opportunities only.
filter[past]Filter to signups for past registration opportunities only.
filter[ongoing]Filter to signups for ongoing registration opportunities only.
filter[withTrashed]Include soft-deleted signups. Defaults to excluding deleted.
filter[program[archived_at]]Filter by registration opportunity archived status. Pass empty string to exclude archived registration opportunities.
filter[program[deleted_at]]Filter by registration opportunity deleted status. Pass empty string to exclude deleted registration opportunities.
includeInclude related resources (comma-separated). Options: additionalMember, additionalMember.emergency, files, guest, program, program.parentProgram, transaction, user, user.family, user.family.emergency, formSubmissions, subscriptionSchedule.config.configurable, subscriptionSchedule.paymentsReceived, attendanceRecords.
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 program signups › Responses
Paginated set of ProgramSignupResource
current_pagefromlast_pageper_pagetototalGet a program signup
path Parameters
program_signupquery Parameters
includeInclude related resources (comma-separated). Options: additionalMember, additionalMember.emergency, files, guest, program, program.parentProgram, transaction, user, user.family, user.family.emergency, formSubmissions, subscriptionSchedule.config.configurable, subscriptionSchedule.paymentsReceived, attendanceRecords.
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 program signup › Responses
ProgramSignupResource
idprogram_iduser_idguest_idadditional_member_idtransaction_idsubscription_schedule_idticket_uuidproduct_idpayment_methodpaidamount_paidGross amount paid for this signup, in cents (principal only, before refunds). For subscription signups, this is the sum of installment transactions; for one-off signups, it falls back to the signup's stored amount_paid.
amount_refundedAbsolute total refunded for this signup, in cents (principal only). Net paid = amount_paid - amount_refunded.
number_of_guestsquantityassociated_emailassociated_nameassociated_addressassociated_telephoneparticipant_nameparticipant_dobadditional_member_nameadditional_member_dobadditional_member_gender_identityadditional_member_medicaladditional_member_emergency_contactcreated_atupdated_atdeleted_timestampcancelled_atTimestamp set only when the signup was intentionally cancelled.
cancellation_actorRole of the user who intentionally cancelled the signup.
program_nameRegistration opportunity name, selected via join on the list
endpoint so the table can render without including the full
program resource. Omitted when the query does not join programs.
parent_program_idProgram ID of the signup's registration opportunity, selected via join on the list endpoint. Omitted when the query does not join programs.
program_freeWhether the registration opportunity is free, selected via join on the list endpoint. Omitted when the query does not join programs.
userUser who created this signup.
guestGuest associated with this signup (for non-member signups).
additional_memberAdditional family member registered through this signup.
programRegistration opportunity this signup belongs to.
transactionPayment transaction for this signup.
filesFiles uploaded by the user as part of this signup.
form_submissionsForm submissions associated with this signup.
subscription_scheduleRecurring subscription schedule for this signup.
attendance_recordsAttendance records for this signup across all dates.
list_of_activitiesComma-separated list of activities from the program.