Program

  • allow_file_uploads
    Type: boolean
    required

    Whether registrants are allowed to upload files during signup.

  • archived_at
    Type: string | nullFormat: ISO 8601 (UTC)
    required

    When this program was archived, null if not archived.

  • auto_archive
    Type: boolean
    required

    Whether registration opportunities under this program are automatically archived after their event dates pass.

  • auto_archive_days
    Type: integer
    required

    Number of days after event_end_date to wait before auto-archiving (0 = immediately).

  • available_spots
    Type: integer | null
    required

    Number of remaining spots available to be claimed.

  • block_facility_calendars
    Type: boolean
    required

    Whether facility calendars should be blocked by this program.

  • cap_registration_fee
    Type: boolean
    required

    Whether registration fee is applied once per checkout instead of per signup.

  • collection_additional_information
    Type: boolean
    required

    Whether additional signup form data should be collected.

  • created_at
    Type: stringFormat: ISO 8601 (UTC)
    required

    When this record was created.

  • dates
    Type: string | null
    required

    Human-readable formatted event date range for display.

  • deleted_at
    Type: string | nullFormat: ISO 8601 (UTC)
    required

    When this record was soft deleted, null if not deleted.

  • demographic
    Type: string | null
    required

    Audience demographic label for this program.

  • description
    Type: string | null
    required

    Detailed description of the program, may contain HTML.

  • display_only
    Type: boolean
    required

    Whether this program is display-only and not intended for signup.

  • draft
    Type: boolean
    required

    Whether this program is in draft mode and not yet published.

  • event_end_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required

    When the program's events end. All registration opportunities run within this window.

  • event_end_time
    Type: string | null
    required

    Event end time in tenant timezone (24-hour HH:mm).

  • event_start_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required

    When the program's events begin. All registration opportunities run within this window.

  • event_start_time
    Type: string | null
    required

    Event start time in tenant timezone (24-hour HH:mm).

  • facility_ids
    Type: array integer[]
    required

    Facility identifiers linked to this program.

  • file_uploads_max
    Type: integer | null
    required

    Maximum number of files allowed per signup, or null for default behavior.

  • file_uploads_required
    Type: boolean
    required

    Whether at least one file upload is required at signup.

  • force_participant_selection
    Type: boolean
    required

    Whether participants must be selected before checkout.

  • form_id
    Type: integer | null
    required

    Optional linked form identifier for additional questions.

  • gl_code
    Type: string | null
    required

    GL code for accounting/financial reporting on program transactions.

  • hide_participant_details
    Type: boolean
    required

    Whether enrollment counts, participant avatars, and spots remaining are hidden on the program page.

  • id
    Type: integer
    required

    Unique identifier for the program.

  • ignores_tax_rates
    Type: boolean
    required

    Whether this program is configured to ignore tenant tax rates.

  • instructor
    Type: string | null
    required

    Instructor or facilitator name shown for this program.

  • is_event
    Type: boolean
    required

    Whether this program represents a single event rather than a series of registration opportunities.

  • is_hidden
    Type: boolean
    required

    Whether this program is hidden from public listings.

  • is_online
    Type: boolean
    required

    Whether the program is delivered online.

  • limit
    Type: integer | null
    required

    Legacy capacity limit alias retained for compatibility with existing clients.

  • location_address
    Type: string | null
    required

    Optional street address for the location.

  • location_latitude
    nullable
    required

    Latitude for map display when a location is set.

    • Type: number

      Latitude for map display when a location is set.

  • location_longitude
    nullable
    required

    Longitude for map display when a location is set.

    • Type: number

      Longitude for map display when a location is set.

  • location_name
    Type: string | null
    required

    Optional display name for the physical location.

  • manual_order_enabled
    Type: boolean
    required

    Whether this item is pinned in the recommended sort order.

  • member_pricing_savings
    Type: object | null
    required

    Best currently available member pricing savings versus guest pricing.

    • guest_price
      Type: integer
      required

      Integer numbers.

    • name
      Type: string
      required
    • price
      Type: integer
      required

      Integer numbers.

    • savings
      Type: integer
      required

      Integer numbers.

  • multiple_signups
    Type: boolean
    required

    Whether users may submit multiple signups for this program.

  • ongoing
    Type: boolean
    required

    Whether this is an ongoing program with no fixed end date.

  • participant_must_hold_membership
    Type: boolean
    required

    Whether the selected participant for a signup must hold the membership that gates the chosen price tier.

  • pay_by_cash
    Type: boolean
    required

    Whether this program allows cash payment option.

  • profile_image
    Type: string | null
    required

    URL to the program's profile/header image.

  • prompt_for_number_of_guests
    Type: boolean
    required

    Whether checkout prompts for number of guests.

  • prompt_for_registrant
    Type: boolean
    required

    Whether checkout prompts for registrant selection.

  • readable_event_end_date
    Type: string | null
    required

    Human-readable event end date in tenant timezone.

  • readable_event_start_date
    Type: string | null
    required

    Human-readable event start date in tenant timezone.

  • registration_dates
    Type: string | null
    required

    Human-readable formatted registration date range for display.

  • registration_end_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required

    When registration closes for this program. Users cannot sign up after this date.

  • registration_end_time
    Type: string | null
    required

    Registration close time in tenant timezone (24-hour HH:mm).

  • registration_fee
    Type: integer | null
    required

    Registration fee amount in minor currency units (for example, cents).

  • registration_start_date
    Type: string | nullFormat: ISO 8601 (UTC)
    required

    When registration opens for this program. Users cannot sign up before this date.

  • registration_start_time
    Type: string | null
    required

    Registration open time in tenant timezone (24-hour HH:mm).

  • require_emergency_contact_information
    Type: boolean
    required

    Whether emergency contact information is required at signup.

  • reserved_spots
    Type: integer
    required

    Number of spots reserved by capped registration opportunities.

  • reserved_spots_remaining
    Type: integer | null
    required

    Remaining reserved spots after reserved signups are counted.

  • reserved_spots_signups
    Type: integer
    required

    Number of signups currently consuming reserved spots.

  • show_participant_list
    Type: boolean
    required

    Whether participants can view the participant list for this program.

  • sort_order
    Type: integer
    required

    Display order for sorting in listings.

  • status
    Type: string
    required

    Current status of the program (e.g. Active, Archived, Draft, Upcoming, Ongoing, Past, dates_not_set when no aggregate event window exists).

  • title
    Type: string
    required

    Display name of the program shown to users.

  • total_signups
    Type: integer
    required

    Total active signups across registration opportunities.

  • total_spots
    Type: integer | null
    required

    Total number of signup spots across all registration opportunities.

  • uncapped_spots
    Type: integer | null
    required

    Number of spots available to uncapped registration opportunities.

  • uncapped_spots_remaining
    Type: integer | null
    required

    Remaining uncapped spots after uncapped signups are counted.

  • uncapped_spots_signups
    Type: integer | null
    required

    Number of signups currently consuming uncapped spots.

  • unsplash_author_link
    Type: string | null
    required

    Unsplash credit URL for the selected profile image author.

  • unsplash_author_name
    Type: string | null
    required

    Unsplash credit author name for the selected profile image.

  • updated_at
    Type: stringFormat: ISO 8601 (UTC)
    required

    When this record was last updated.

  • volunteer_opportunities_ids
    Type: array integer[]
    required

    Volunteer opportunity identifiers linked to this program.

  • waitlist_enabled
    Type: boolean
    required

    Whether waitlist functionality is enabled for this program.

  • facilities
    Type: string

    Facilities/locations where this program takes place.

  • registration_opportunities
    Type: string

    Registration opportunities available for registration under this program.

  • tags
    Type: string
  • volunteer_opportunities
    Type: string

    Volunteer opportunities associated with this program.

  • waiver_assignments
    Type: string

    Waiver assignments associated with this program.