Schemas

AttendanceRecordResource

id

integer · required

attendance_sheet_id

integer · required

attendance_sheet_session_id

integer | null · required

session_date

string | null · required

Calendar date of the session this record belongs to (YYYY-MM-DD).

Example: 2026-09-19

is_locked

boolean · required

Whether staff may not mark this record because its session is still in the future.

Example: false

program_signup_id

integer · required

status

string · required

notes

string | null · required

marked_at

string | null · required

marked_by

integer | null · required

can_update

boolean · required

Whether the current viewer may update this record.

Example: true

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

attendance_sheet

string

The attendance sheet this record belongs to.

program_signup

string

The program signup (attendee) this record tracks.

AttendanceSheetResource

id

integer · required

registration_opportunity_ids

integer[] · required

Registration opportunity identifiers linked to this attendance sheet.

Example: [42,43]

date

string · required

coverage

string · required

Whether this sheet covers a single date or a date series.

Example: series

starts_on

string | null · required

First session calendar date (YYYY-MM-DD).

Example: 2026-09-05

ends_on

string | null · required

Last session calendar date (YYYY-MM-DD).

Example: 2026-10-24

session_count

integer · required

Number of sessions on this sheet.

Example: 8

current_session_index

integer | null · required

1-based index of the current session, or null when the sheet has no sessions.

Example: 3

registrant_count

integer · required

Distinct registrants on this sheet.

Example: 6

can_update

boolean · required

Whether the current viewer may update or delete this sheet.

Example: true

can_add_person

boolean · required

Whether the current viewer may register a person from this sheet.

Example: true

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

parentProgram

string | null · required

Program this attendance sheet belongs to (derived from first registration opportunity).

recordsCount

integer | null

registrationOpportunities

string

Registration opportunities this attendance sheet includes.

records

string

Attendance records for this sheet.

AttendanceSheetSession[]

Sessions this sheet covers, oldest first.

AttendanceSheetSession

id

integer · required

date

string · required

Calendar date of this session (YYYY-MM-DD).

Example: 2026-09-19

index

integer · required

1-based session index on the sheet.

Example: 3

is_current

boolean · required

Whether this session is the current one for header/pills.

Example: true

is_locked

boolean · required

Whether staff may not mark attendance for this session yet.

Example: false

BookableEntity

id

integer · required

name

string · required

description

string · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

booking_interval

integer | null · required

buffer_minutes

integer | null · required

deleted_at

string | null · date-time · required

membership_required

string | null · required

tenant_id

integer · required

parent_entity

integer | null · required

minimum_length

number · required

maximum_length

number · required

publicly_exposed

integer · required

prompt_for_booking_owner

integer · required

prompt_for_adding_more_users

integer · required

prompt_for_number_of_guests

integer · required

require_guest_phone

boolean · required

possible_states

array | null · required

publicly_exposed_allow_bookings

integer · required

type

string · required

booking_instructions

string | null · required

send_reminder_emails

boolean · required

remind_hours_before

integer · required

reminder_email_subject

string | null · required

reminder_email_body

string | null · required

publicly_exposed_hide_user_names

integer · required

booking_request_deadline

integer | null · required

archived_at

string | null · required

memberships_required

array | null · required

membership_requirement_mode

string · required

future_days

integer · required

manager_only

integer · required

basis_time

string | null · required

capacity

integer | null · required

view_type

string · required

user_recurring_bookings

boolean · required

user_specified_reason

boolean · required

sort_order

integer · required

manual_order_enabled

boolean · required

apply_tax

boolean · required

array · required

BookingRequestResource

id

integer · required

uuid

string | null · required

Public identifier used by guest form links.

Example: 9c1b3f2a-4d5e-6789-abcd-ef1234567890

starting_at

string · required

ending_at

string · required

cost

integer · required

Quoted cost in integer cents.

Example: 5000

reason

string | null · required

display_text

string | null · required

Optional calendar label.

Example: Smith party

declined_at

string | null · required

decline_reason

string | null · required

user_id

integer | null · required

guest_id

integer | null · required

organization_id

integer | null · required

bookable_entity_id

integer · required

booking_state_id

integer | null · required

recurring_id

integer | null · required

transaction_id

integer | null · required

form_responses_locked

boolean · required

created_at

string | null · required

updated_at

string | null · required

deletion_reason

string | null · required

deleted_at

string | null · required

readable_start_time

string | null · required

readable_end_time

string | null · required

can_cancel

boolean · required

Whether the owner may still cancel this request.

Example: true

starting_at_utc_ts

integer | null · required

Unix timestamp of starting_at in UTC.

Example: 1789495200

owner

object | null · required

Resolved booking contact. Prefer this over the raw user/guest/organization relations.

Example: {"type":"user","id":42,"name":"Jane Doe","email":"jane@example.com","telephone":"416-555-1234"}

required

Facility this request is for. Slim {id, name} by default; the full bookable entity is returned when include=bookableEntity is sent.

required

Workflow state. Slim {id, state_name, color} by default; the full state object is returned when include=bookingState is sent.

user

string

guest

string

organization

string

booking_items

string

tags

string

files

string

notes

string

form_submissions

string

recurring_booking

string

booking_contact_details

string

transaction

string

facilities

string

starting_at_ts

combined_notes

total_amount_of_invoices

invoices_paid

associated_recurring_ids

readable_booking_item_one_name

readable_booking_item_two_name

readable_booking_item_one_description

readable_booking_item_two_description

most_expensive_hourly_rate

cost_for_user_and_availability

flat_total_for_user_and_availability

owner_name

owner_email

owner_telephone

participants

participant_name

remaining_recurring_bookings

booking_item_one

booking_item_two

facilities_with_cost

created_by

next_state

object | null

The state this request advances to next in the facility's workflow. Present when append=next_state is requested; null when the request is already in the final state.

previous_state

object | null

The state this request can be moved back to. Present when append=previous_state is requested; null when the request is in the first state.

buffer_minutes

integer | null

Held minutes after this request. Present when append=buffer_minutes is requested.

Example: 15

BookingState

id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

state_name

string · required

color

string · required

order

integer · required

blocks_time

boolean · required

tenant_id

integer | null · required

Boundary

id

integer · required

tenant_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

title

string · required

array · required

deleted_at

string | null · date-time · required

CardDeliveryActivityResource

id

integer · required

The unique identifier of the activity log entry.

Example: 1234

request_hash

string | null · required

Unique request hash for tracing the request from API call to delivery.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

message

string · required

Human-readable message describing the card delivery event.

Example: Membership card delivered to john@example.com

delivered_at

string · required

ISO 8601 timestamp of when the card was delivered.

Example: 2025-06-15T14:30:00.000Z

timestamp

integer · required

Unix timestamp of when the card was delivered.

Example: 1718460600

user_id

integer · required

The ID of the user who received the card.

Example: 42

member_id

string | null · required

The member ID of the user who received the card.

Example: MEM-12345

obfuscated_emails

string[] · required

Array of obfuscated email addresses where the card was sent.

Example: ["j***@example.com"]

emails_attempted

string[] · required

Array of obfuscated email addresses that failed to send.

Example: []

email_count

integer · required

Total number of emails sent.

Example: 1

object · required

Types of membership cards delivered.

Example: {"pdf":true,"apple_pass":false,"google_wallet":false}

status

string | null · required

Delivery status.

Example: delivered

failure_reason

string | null · required

Failure reason if status is failed.

Example: null

error_message

string | null · required

Error message associated with the failure.

Example: null

CustomProfileFieldResource

id

integer · required

tenant_id

integer | null · required

name

string · required

display_on_membership_card

boolean · required

user_editable

boolean · required

applies_to_users

boolean · required

applies_to_family_members

boolean · required

locked

boolean · required

parent_profile_field_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

CustomProfileFieldValueResource[]

CustomProfileFieldValueResource

id

integer · required

tenant_id

integer | null · required

value

string · required

user_id

integer | null · required

family_id

integer | null · required

custom_profile_field_id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

custom_profile_field

string

EmergencyContact

id

integer · required

family_id

integer · required

name

string · required

telephone

string · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

FacilityResource

id

integer · required

The unique identifier of the facility.

Example: 12

name

string · required

description

string | null · required

type

string · required

How bookings are made: instant confirms immediately, request needs a manager to approve.

Example: instant

parent_id

integer | null · required

The id of the facility this one sits inside, or null when it is a top-level facility.

Example: 3

capacity

integer | null · required

The maximum number of people the facility holds.

Example: 50

booking_interval

integer | null · required

The length in minutes of each bookable slot.

Example: 60

buffer_minutes

integer | null · required

effective_buffer_minutes

integer · required

minimum_length

number | null · required

The shortest bookable duration, in hours.

Example: 0.5

maximum_length

number | null · required

The longest bookable duration, in hours.

Example: 4

future_days

integer | null · required

How many days ahead members may book.

Example: 30

basis_time

string | null · required

The time of day booking slots are aligned from.

Example: 08:00:00

booking_request_deadline

integer | null · required

How many hours before the start time a booking request must be submitted.

Example: 48

booking_instructions

string | null · required

Instructions shown to members when they book.

Example: Please arrive 10 minutes before your booking.

user_recurring_bookings

boolean · required

Whether members may create repeating bookings themselves.

Example: false

user_specified_reason

boolean · required

Whether members must give a reason when booking.

Example: false

publicly_exposed

boolean · required

Whether the facility's schedule is visible to the public.

Example: true

publicly_exposed_allow_bookings

boolean · required

Whether the public schedule also accepts bookings.

Example: true

publicly_exposed_hide_user_names

boolean · required

Whether the public schedule hides who made each booking.

Example: false

manager_only

boolean · required

Whether only managers may book the facility.

Example: false

prompt_for_booking_owner

boolean · required

Whether the booking form asks who the booking is for.

Example: false

prompt_for_adding_more_users

boolean · required

Whether the booking form asks for additional members to add.

Example: false

prompt_for_number_of_guests

boolean · required

Whether the booking form asks how many guests are attending.

Example: false

memberships_required

array | null · required

Stripe product ids of the memberships a member must hold to book, or null when the facility is open to everyone.

Example: ["prod_abc123"]

membership_requirement_mode

string · required

Whether a member needs any one (or) or all (and) of memberships_required.

Example: or

status

string · required

Whether the facility is currently bookable or has been archived.

Example: active

profile_image

string | null · required

sort_order

integer · required

Position of the facility in the manually ordered list.

Example: 0

archived_at

string | null · required

ISO 8601 timestamp of when the facility was archived, or null while it is active.

Example: 2025-01-15T10:30:00.000000Z

created_at

string | null · required

ISO 8601 timestamp of when the facility was created.

Example: 2025-01-15T10:30:00.000000Z

updated_at

string | null · required

ISO 8601 timestamp of when the facility was last changed.

Example: 2025-01-20T14:45:00.000000Z

object | null

The facility this one sits inside. Included when the parent relation is requested.

children

array | null

The sub-facilities inside this one. Included when the children relation is requested.

Family

id

integer · required

user_id

integer | null · required

invited_user_id

integer | null · required

name

string · required

gender

string | null · required

allergies

string | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

age

integer | null · required

medical

string | null · required

guest_id

integer | null · required

email

string | null · required

deleted_at

string | null · date-time · required

tenant_id

integer | null · required

date_of_birth

string | null · required

telephone

string | null · required

primary

boolean · required

member_id

string | null · required

FamilyMember

id

integer · required

user_id

integer | null · required

invited_user_id

integer | null · required

guest_id

integer | null · required

name

string · required

email

string | null · required

telephone

string | null · required

gender

string | null · required

date_of_birth

string | null · YYYY-MM-DD · required

age

integer | null · required

allergies

string | null · required

medical

string | null · required

primary

boolean · required

pending_invite

boolean · required

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

deleted_at

string | null · ISO 8601 (UTC) · required

EmergencyContact

Relations

Form

id

integer · required

parent_form_id

integer | null · required

title

string · required

creator_id

integer | null · required

array · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

tenant_id

integer | null · required

form_template_key

string | null · required

type

string · required

allow_repeat_submissions

boolean · required

original_form_id

integer | null · required

uuid

string | null · required

description

string | null · required

profile_field_associations

array | null · required

bookable_entity_id

integer | null · required

link

string | null · required

status

string · enum · required

Enum values:

archived

active

MarkAttendanceRecordRequest

status

string · enum · required

Enum values:

absent

excused

excluded

late

present

unmarked

notes

string | null · maxLength: 1000

marked_at

string · date-time

marked_by

integer

MembershipTypeResource

id

integer · required

title

string · required

description

string | null · required

product_id

string | null · required

type

string | null · required

base_membership_id

integer | null · required

status

string | null · required

metadata

array | null · required

renewal_notifications

boolean · required

renewal_notifications_pre_expiration

boolean · required

renewal_notifications_post_expiration

boolean · required

renewal_notifications_pre_expiration_days

integer | null · required

renewal_notifications_post_expiration_days

integer | null · required

pre_expiration_leadup

integer | null · required

user_auto_renewals

boolean · required

require_auto_renewal

boolean · required

exclude_from_tax

boolean · required

membership_card_id

integer | null · required

hidden

boolean · required

hide_starting_at_price

boolean · required

visibility_requires_base_membership

boolean · required

forced_bundle_with_base

boolean · required

When true (add-ons only), the add-on is only offered bundled with its base; the base is not listed alone.

Example: true

exclude_from_parent_tenant_fee

boolean · required

form_id

integer | null · required

disable_default_card

boolean · required

sort_order

integer | null · required

manual_order_enabled

boolean · required

created_at

string · required

updated_at

string · required

deleted_at

string | null · required

user_blocked_from_membership_checkout

boolean | null · required

Whether the authenticated member is blocked from purchasing a membership because their coverage is provided through a family group holder's membership instead. Only computed on the show endpoint for an authenticated member; null otherwise (e.g. guests, or contexts that don't compute this, such as the index listing).

Example: false

user_can_purchase

boolean | null · required

Whether the authenticated member can purchase this membership type. Only computed on the show endpoint for authenticated members; null otherwise.

Example: true

Waiver[] · required

Waivers associated with this membership type.

PlanResource[] · required

Plans associated with this membership type.

array

PlanResource[]

WaiverAssignment[]

object | null

Raw per-locale values and their provenance for the manager translation editor, plus each field's translation mode (auto translates into every supported locale, source shows the English value everywhere). Omitted for non-manager readers.

Example: {"title":{"mode":"auto","values":{"en-CA":{"origin":"human","value":"Gold Membership"},"fr-CA":{"origin":"machine","value":"Adhésion Or"}}}}

ParentProgram

id

integer · required

tenant_id

integer | null · required

title

string | null · required

description

string | null · required

limit

integer · required

demographic

string | null · required

instructor

string | null · required

location_name

string | null · required

location_address

string | null · required

location_latitude

number | null · required

location_longitude

number | null · required

is_online

integer · required

registration_start_date

string | null · required

registration_end_date

string | null · required

event_start_date

string | null · required

event_end_date

string | null · required

profile_image

string | null · required

unsplash_author_name

string | null · required

unsplash_author_link

string | null · required

multiple_signups

boolean · required

pay_by_cash

boolean · required

collection_additional_information

boolean · required

prompt_for_number_of_guests

boolean · required

prompt_for_registrant

boolean · required

waitlist_enabled

boolean · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

archived_at

string | null · required

block_facility_calendars

boolean · required

auto_archive

boolean · required

auto_archive_days

integer · required

participant_must_hold_membership

boolean · required

ongoing

boolean · required

draft

boolean · required

require_emergency_contact_information

boolean · required

registration_fee

integer | null · required

force_participant_selection

boolean · required

is_event

boolean · required

form_id

integer | null · required

display_only

boolean · required

is_hidden

boolean · required

show_participant_list

boolean · required

hide_participant_details

boolean · required

total_spots

integer | null · required

cap_registration_fee

boolean · required

allow_file_uploads

boolean · required

file_uploads_required

boolean | null · required

file_uploads_max

integer | null · required

sort_order

integer · required

manual_order_enabled

boolean · required

gl_code

string | null · required

available_spots

integer | null · required

dates

string · required

days_until_event

string | null · required

event_end_time

string · required

event_start_time

string · required

array · required

ignores_tax_rates

boolean · required

readable_event_end_date

string · required

readable_event_start_date

string · required

registration_dates

string | null · required

registration_end_time

string · required

registration_start_time

string · required

status

string · enum · required

Enum values:

Past

Upcoming

Active

dates_not_set

Ongoing

Draft

Archived

array · required

reserved_spots

integer · required

reserved_spots_remaining

integer | null · required

reserved_spots_signups

integer · min: 0 · required

total_signups

integer · min: 0 · required

uncapped_spots

integer | null · required

uncapped_spots_remaining

integer | null · required

uncapped_spots_signups

integer · min: 0 · required

ParentProgramOptionResource

id

integer · required

title

string · required

draft

boolean · required

archived_at

string | null · required

Permission

id

integer | string · required

name

string · required

guard_name

string · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

PlanResource

id

integer · required

tenant_id

integer | null · required

membership_type_id

integer · required

nickname

string | null · required

description

string | null · required

amount

integer | null · required

status

string | null · required

plan_id

string | null · required

subscription_schedule_id

string | null · required

metadata

array | null · required

boundary_id

integer | null · required

plan_to_hide

integer | null · required

pricing_type

string | null · required

is_business_plan

boolean · required

max_beneficiaries

integer | null · required

interval

string | null · required

sort_order

integer | null · required

manual_order_enabled

boolean · required

created_at

string · required

updated_at

string · required

deleted_at

string | null · required

array

user_in_boundary

boolean | null

object

object | null

Example: {"nickname":{"mode":"auto","values":{"en-CA":{"origin":"human","value":"Monthly"},"fr-CA":{"origin":"machine","value":"Mensuel"}}}}

Program

id

integer · required

Unique identifier for the program.

Example: 5

title

string · required

Display name of the program shown to users.

Example: Summer Sports Programs

description

string | null · required

Detailed description of the program, may contain HTML.

Example: A collection of exciting summer sports programs for all ages.

event_start_date

string | null · ISO 8601 (UTC) · required

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

Example: 2025-06-01T12:00:00.000000Z

event_end_date

string | null · ISO 8601 (UTC) · required

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

Example: 2025-08-31T15:00:00.000000Z

registration_start_date

string | null · ISO 8601 (UTC) · required

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

Example: 2025-01-01T12:00:00.000000Z

registration_end_date

string | null · ISO 8601 (UTC) · required

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

Example: 2025-02-03T12:00:00.000000Z

ongoing

boolean · required

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

Example: false

status

string · required

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

Example: active

dates

string | null · required

Human-readable formatted event date range for display.

Example: June 1 - August 31, 2025

registration_dates

string | null · required

Human-readable formatted registration date range for display.

Example: May 1 - May 31, 2025

is_event

boolean · required

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

Example: false

draft

boolean · required

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

Example: false

is_hidden

boolean · required

Whether this program is hidden from public listings.

Example: false

profile_image

string | null · required

URL to the program's profile/header image.

Example: https://example.com/images/summer-sports.jpg

limit

integer | null · required

Legacy capacity limit alias retained for compatibility with existing clients.

Example: 120

total_spots

integer | null · required

Total number of signup spots across all registration opportunities.

Example: 120

available_spots

integer | null · required

Number of remaining spots available to be claimed.

Example: 34

total_signups

integer · required

Total active signups across registration opportunities.

Example: 86

reserved_spots

integer · required

Number of spots reserved by capped registration opportunities.

Example: 60

reserved_spots_signups

integer · required

Number of signups currently consuming reserved spots.

Example: 44

reserved_spots_remaining

integer | null · required

Remaining reserved spots after reserved signups are counted.

Example: 16

uncapped_spots

integer | null · required

Number of spots available to uncapped registration opportunities.

Example: 60

uncapped_spots_signups

integer | null · required

Number of signups currently consuming uncapped spots.

Example: 42

uncapped_spots_remaining

integer | null · required

Remaining uncapped spots after uncapped signups are counted.

Example: 18

demographic

string | null · required

Audience demographic label for this program.

Example: Youth (Ages 8-12)

instructor

string | null · required

Instructor or facilitator name shown for this program.

Example: Jane Coach

location_name

string | null · required

Optional display name for the physical location.

Example: Main Gymnasium

location_address

string | null · required

Optional street address for the location.

Example: 123 Main St, Springfield, IL

location_latitude

number | string | null · required

Latitude for map display when a location is set.

Example: 43.6532

location_longitude

number | string | null · required

Longitude for map display when a location is set.

Example: -79.3832

is_online

boolean · required

Whether the program is delivered online.

Example: false

readable_event_start_date

string | null · required

Human-readable event start date in tenant timezone.

Example: Thu, Jun 1, 2025 7:00 PM

readable_event_end_date

string | null · required

Human-readable event end date in tenant timezone.

Example: Sat, Aug 31, 2025 5:00 PM

event_start_time

string | null · required

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

Example: 19:00

event_end_time

string | null · required

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

Example: 17:00

registration_start_time

string | null · required

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

Example: 09:00

registration_end_time

string | null · required

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

Example: 23:59

display_only

boolean · required

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

Example: false

unsplash_author_name

string | null · required

Unsplash credit author name for the selected profile image.

Example: Alex Photographer

unsplash_author_link

string | null · required

Unsplash credit URL for the selected profile image author.

Example: https://unsplash.com/@alex

multiple_signups

boolean · required

Whether users may submit multiple signups for this program.

Example: false

prompt_for_number_of_guests

boolean · required

Whether checkout prompts for number of guests.

Example: true

prompt_for_registrant

boolean · required

Whether checkout prompts for registrant selection.

Example: true

waitlist_enabled

boolean · required

Whether waitlist functionality is enabled for this program.

Example: true

force_participant_selection

boolean · required

Whether participants must be selected before checkout.

Example: false

show_participant_list

boolean · required

Whether participants can view the participant list for this program.

Example: true

hide_participant_details

boolean · required

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

Example: false

pay_by_cash

boolean · required

Whether this program allows cash payment option.

Example: false

registration_fee

integer | null · required

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

Example: 2500

cap_registration_fee

boolean · required

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

Example: false

ignores_tax_rates

boolean · required

Whether this program is configured to ignore tenant tax rates.

Example: false

collection_additional_information

boolean · required

Whether additional signup form data should be collected.

Example: true

require_emergency_contact_information

boolean · required

Whether emergency contact information is required at signup.

Example: true

block_facility_calendars

boolean · required

Whether facility calendars should be blocked by this program.

Example: false

auto_archive

boolean · required

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

Example: true

auto_archive_days

integer · required

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

Example: 0

participant_must_hold_membership

boolean · required

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

Example: false

form_id

integer | null · required

Optional linked form identifier for additional questions.

Example: 42

allow_file_uploads

boolean · required

Whether registrants are allowed to upload files during signup.

Example: true

file_uploads_required

boolean · required

Whether at least one file upload is required at signup.

Example: false

file_uploads_max

integer | null · required

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

Example: 3

volunteer_opportunities_ids

integer[] · required

Volunteer opportunity identifiers linked to this program.

Example: [3,7,11]

facility_ids

integer[] · required

Facility identifiers linked to this program.

Example: [2,5]

sort_order

integer · required

Display order for sorting in listings.

Example: 0

manual_order_enabled

boolean · required

Whether this item is pinned in the recommended sort order.

Example: false

gl_code

string | null · required

GL code for accounting/financial reporting on program transactions.

Example: 4000-100

created_at

string · ISO 8601 (UTC) · required

When this record was created.

Example: 2025-01-15T10:30:00.000000Z

updated_at

string · ISO 8601 (UTC) · required

When this record was last updated.

Example: 2025-01-20T14:45:00.000000Z

deleted_at

string | null · ISO 8601 (UTC) · required

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

Example: 2025-01-25T12:00:00.000000Z

archived_at

string | null · ISO 8601 (UTC) · required

When this program was archived, null if not archived.

Example: 2025-01-30T18:00:00.000000Z

facilities

string

Facilities/locations where this program takes place.

registration_opportunities

string

Registration opportunities available for registration under this program.

member_pricing_savings

object | null

Best currently available member pricing savings versus guest pricing.

Example: {"name":"Gold Membership","guest_price":4500,"price":3500,"savings":1000}

volunteer_opportunities

string

Volunteer opportunities associated with this program.

waiver_assignments

string

Waiver assignments associated with this program.

tags

string

ProgramSignupResource

id

integer · required

program_id

integer · required

user_id

integer | null · required

guest_id

integer | null · required

additional_member_id

integer | null · required

transaction_id

integer | null · required

subscription_schedule_id

integer | null · required

ticket_uuid

string | null · required

product_id

string | null · required

payment_method

string | null · required

paid

integer · required

amount_paid

integer · required

Gross 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.

Example: 75

amount_refunded

integer · required

Absolute total refunded for this signup, in cents (principal only). Net paid = amount_paid - amount_refunded.

Example: 0

number_of_guests

integer · required

quantity

integer · required

associated_email

string | null · required

associated_name

string | null · required

associated_address

string | null · required

associated_telephone

string | null · required

participant_name

string | null · required

participant_dob

string | null · YYYY-MM-DD · required

additional_member_name

string | null · required

additional_member_dob

string | null · YYYY-MM-DD · required

additional_member_gender_identity

string | null · required

additional_member_medical

string | null · required

additional_member_emergency_contact

string | null · required

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

deleted_timestamp

string | null · ISO 8601 (UTC) · required

cancelled_at

string | null · ISO 8601 (UTC) · required

Timestamp set only when the signup was intentionally cancelled.

Example: 2025-05-25T10:00:00.000000Z

cancellation_actor

string | null · required

Role of the user who intentionally cancelled the signup.

Example: member

object

POS collection snapshot. Present only on terminal registration endpoints. can_collect is false when ineligible_reason is set (paid, zero balance, recurring, or unconfirmed billing). Amounts are in cents and already account for discounts, taxes, and previous payments.

Example: {"can_collect":true,"ineligible_reason":null,"subtotal":10000,"discount":1000,"tax":1170,"total":10170,"amount_paid":2500,"outstanding_balance":7670,"payment_status":"partially_paid","currency":"cad","payment_methods":["card"]}

program_name

string | null

Registration opportunity name, returned on the list endpoint without needing include=program. Omitted elsewhere.

Example: Youth Basketball Camp

parent_program_id

integer | null

Program ID of the signup's registration opportunity, returned on the list endpoint. Omitted elsewhere.

Example: 5

program_free

boolean | null

Whether the registration opportunity is free, returned on the list endpoint. Omitted elsewhere.

Example: false

user

string

User who created this signup.

guest

string

Guest associated with this signup (for non-member signups).

additional_member

string

Additional family member registered through this signup.

program

string

Registration opportunity this signup belongs to.

transaction

string

Payment transaction for this signup.

files

string

Files uploaded by the user as part of this signup.

form_submissions

string

Form submissions associated with this signup.

subscription_schedule

string

Recurring subscription schedule for this signup.

attendance_records

string

Attendance records for this signup across all dates.

list_of_activities

string | null

Comma-separated list of activities from the program.

Example: Basketball, Soccer, Volleyball

RegisterAttendanceRequest

program_id

integer · required

participant_type

string · enum · required

Enum values:

existing_user

walk_in

status

string · enum · required

Enum values:

absent

excused

excluded

late

present

unmarked

user_id

integer | null

additional_member_id

integer | null

name

string | null · maxLength: 255

email

string | null · email · maxLength: 255

telephone

string | null · maxLength: 255

date_of_birth

string | null · date-time

amount_paid

number | null · min: 0

payment_method

string | null · maxLength: 255

trigger_assign_email

boolean | null

attach_invoice

boolean | null

object

notes

string | null · maxLength: 1000

marked_at

string · date-time

marked_by

integer

RegistrationOpportunityOptionResource

id

integer · required

name

string · required

parent_program_id

integer | null · required

form_id

integer | null · required

class_limit

integer | null · required

status

string · required

ongoing

boolean · required

event_start_date

string | null · ISO 8601 (UTC) · required

event_end_date

string | null · ISO 8601 (UTC) · required

archived_at

string | null · required

signup_count

integer

RegistrationOpportunityResource

id

integer · required

display_order

integer | null · required

is_pinned

boolean · required

name

string · required

description

string | null · required

parent_program_id

integer | null · required

can_manage_registration_opportunity

boolean · required

Whether the current viewer may manage this registration opportunity.

Example: true

class_limit

integer | null · required

event_start_date

string | null · ISO 8601 (UTC) · required

event_end_date

string | null · ISO 8601 (UTC) · required

registration_start_date

string | null · ISO 8601 (UTC) · required

registration_end_date

string | null · ISO 8601 (UTC) · required

registration_open_until_event_start

boolean · required

readable_event_start_date

string | null · required

readable_event_end_date

string | null · required

readable_registration_start_date

string | null · required

readable_registration_end_date

string | null · required

event_start_time

string | null · HH:mm:ss · required

event_end_time

string | null · HH:mm:ss · required

readable_event_start_time

string | null · required

readable_event_end_time

string | null · required

status

string · required

ongoing

boolean · required

archived_at

string | null · ISO 8601 (UTC) · required

deleted_at

string | null · ISO 8601 (UTC) · required

waitlist_enabled

boolean · required

exclude_from_reminder_emails

boolean · required

is_priority_waitlist_locked

boolean · required

multiple_signups

boolean · required

display_to_all_users

boolean · required

hide_from_non_buyers

boolean · required

dob_validation

boolean · required

min_date_of_birth

string | null · YYYY-MM-DD · required

DOB at the minimum allowed age (youngest participant) — the latest calendar date in the range.

Example: 2017-12-31

max_date_of_birth

string | null · YYYY-MM-DD · required

DOB at the maximum allowed age (oldest participant) — the earliest calendar date in the range.

Example: 2013-01-01

program_prices

array | null · required

free

boolean · required

ignore_gst

boolean · required

product_id

string | null · required

registration_start_time

string | null · required

registration_end_time

string | null · required

is_event

boolean · required

prompt_for_registrant

boolean · required

prompt_for_number_of_guests

boolean · required

force_additional_member_info

boolean · required

allow_file_uploads

boolean · required

file_uploads_required

boolean | null · required

file_uploads_max

integer | null · required

pay_by_cash

boolean · required

collect_additional_information

boolean · required

form_id

integer | null · required

created_at

string · ISO 8601 (UTC) · required

updated_at

string · ISO 8601 (UTC) · required

member_savings

integer | null

Member discount savings compared to guest pricing.

Example: 1000

price_for_user

integer | null

Price for the currently authenticated user based on membership status.

Example: 7500

num_signups_remaining_for_user

integer | null

Number of signups remaining for the authenticated user (based on signup limits).

Example: 2

lowest_price_excluded

integer | null

Lowest price available excluding special member pricing.

Example: 5000

highest_price

integer | null

Highest price tier available for this registration opportunity.

Example: 15000

signup_count

integer | null

Total number of active signups for this registration opportunity.

Example: 18

is_full

boolean | null

Whether the registration opportunity has reached its capacity limit.

Example: false

spots_remaining

integer | null

Number of spots remaining before the registration opportunity is full.

Example: 7

user_signup_count

integer | null

Number of signups the authenticated user has for this registration opportunity.

Example: 1

volunteer_price

integer | null

Special discounted price for volunteers.

Example: 5000

volunteer_price_is_free

boolean | null

Whether the registration opportunity is free for volunteers.

Example: true

price_id_for_user

string | null

Stripe price ID applicable for the authenticated user.

Example: price_abc123

required_membership_id_for_user

string | null

Stripe product_id the participant must hold for this signup. Populated only when the program's participant_must_hold_membership setting is on, membership enforcement is enabled for the organization, and the authenticated user qualifies for a membership-gated price tier. Null in every other case. Requested with ?append=... / ?include=... like the other computed-for-user fields.

Example: prod_abc123

price_recurs_for_user

boolean | null

Whether the user's price is a recurring subscription.

Example: true

price_interval_for_user

string | null

Billing interval for recurring prices (day, week, month, year).

Example: month

price_interval_count_for_user

integer | null

Number of intervals between each billing cycle.

Example: 1

can_user_purchase

boolean | null

Whether the authenticated user is eligible to purchase this registration opportunity.

Example: true

required_membership_names

string[]

Distinct 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).

Example: ["Base Membership","Premium Membership"]

signups

string

Signups registered for this registration opportunity.

parent_program

string

Program this registration opportunity belongs to.

prices

string

Pricing tiers available for this registration opportunity.

metadata

string

waivers

string

waitlist_signups

string

Users on the waitlist for this registration opportunity.

attendance_sheets

string

Attendance sheets for this registration opportunity.

occurrences

string

Discrete date/time occurrences for this registration opportunity. Ordered by persisted display position. Admin saves normalize this chronologically.

recurrence_rule

string

Recurrence 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.

ReorderRequest

ids

integer[] · minItems: 1 · unique

prioritized_ids

integer[] · minItems: 1 · unique

SendMembershipCardApiRequest

object · required

User specific data that will stored on the user profile and used to generate the card. If not supplied during this request, the data stored on the user profile will be used.

card_types

string[]

Enum values:

apple

google

pdf

StoreCustomProfileFieldRequest

name

string · required

display_on_membership_card

boolean | null

for_child_tenants

boolean | null

user_editable

boolean | null

applies_to_users

boolean

applies_to_family_members

boolean

StoreCustomProfileFieldValueRequest

custom_profile_field_id

integer · required

value

string | null

user_id

integer | null

family_id

integer | null

StoreFacilityRequest

name

string · maxLength: 191 · required

description

string · maxLength: 16000 · required

publicly_exposed

boolean

publicly_exposed_allow_bookings

boolean

manager_only

boolean

type

string · enum

Enum values:

instant

request

capacity

integer | null · min: 1 · max: 2147483647

booking_interval

integer · enum

Enum values:

buffer_minutes

integer | null · min: 0 · max: 480

future_days

integer · min: 0 · max: 2147483647

basis_time

string

booking_request_deadline

integer | null · min: 0 · max: 4294967295

publicly_exposed_hide_user_names

boolean

prompt_for_booking_owner

boolean

prompt_for_adding_more_users

boolean

prompt_for_number_of_guests

boolean

user_recurring_bookings

boolean

user_specified_reason

boolean

StoreParentProgramRequest

title

string | null · maxLength: 191

description

string | null

ongoing

boolean | null

event_start_date

string | null · date-time

event_end_date

string | null · date-time

profile_image

string | null

location_name

string | null · maxLength: 191

location_address

string | null · maxLength: 191

location_latitude

number | null

location_longitude

number | null

pay_by_cash

boolean | null

collection_additional_information

boolean | null

require_emergency_contact_information

boolean | null

waitlist_enabled

boolean | null

prompt_for_registrant

boolean | null

unsplash_author_name

string | null · maxLength: 191

unsplash_author_link

string | null · maxLength: 191

demographic

string | null · maxLength: 191

instructor

string | null · maxLength: 191

force_participant_selection

boolean | null

display_only

boolean | null

draft

boolean | null

registration_fee

number | null

cap_registration_fee

boolean | null

is_event

boolean | null

multiple_signups

boolean | null

is_hidden

boolean | null

show_participant_list

boolean | null

hide_participant_details

boolean | null

total_spots

integer | null

allow_file_uploads

boolean | null

file_uploads_required

boolean | null

file_uploads_max

integer | null · min: 1 · max: 20

auto_archive

boolean | null

auto_archive_days

integer | null · min: 0

participant_must_hold_membership

boolean | null

gl_code

string | null · maxLength: 255

StoreProgramRequest

name

string · required

parent_program_id

integer · required

description

string | null

class_limit

integer | null

prices

array | null

display_to_all_users

string | null

min_date_of_birth

string | null · date

max_date_of_birth

string | null · date

ongoing

boolean | null

event_start_date

string | null · date-time

event_end_date

string | null · date-time

registration_start_date

string | null · date-time

registration_end_date

string | null · date-time

registration_open_until_event_start

boolean | null

waitlist_enabled

boolean | null

exclude_from_reminder_emails

boolean | null

dob_validation

boolean | null

hide_from_non_buyers

boolean | null

allow_file_uploads

boolean | null

file_uploads_required

boolean | null

file_uploads_max

integer | null · min: 1 · max: 20

StoreUserMembershipRequest

user_id

integer · required

membership_type_id

integer · required

plan_id

integer | null

payment_method

string | null

amount_paid

number | null · min: 0

purchase_date

string | null · date

send_email

boolean | null

Email the member about the assignment. When true, they get a "Membership Assigned" email right away and, about a minute later, their membership card (or the type's membership form PDF when cards are off or the type has no card). Defaults to false, which sends nothing.

StoreUserRequest

first_name

string · maxLength: 255 · required

last_name

string · maxLength: 255 · required

email

string · email · required

name

string | null

middle_name

string | null · maxLength: 255

preferred_name

string | null · maxLength: 255

manager

boolean | null

password

string | null

address

string | null

addressTwo

string | null

city

string | null

state

string | null

zip

string | null

country

string | null

telephone

string | null

business_name

string | null

member_id

string | null

require_address_in_complete_your_profile

boolean | null

require_registration_form_in_complete_your_profile

boolean | null

roles

array | null

Enum values:

TaxIgnore

id

integer · required

program_id

integer | null · required

deleted_at

string | null · date-time · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

parent_program_id

integer | null · required

tenant_id

integer | null · required

membership_type_id

string | null · required

product_id

integer | null · required

bookable_entity_id

integer | null · required

TimeslotSignup

id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

tenant_id

integer | null · required

user_id

integer | null · required

guest_id

integer | null · required

timeslot_id

integer · required

timeslot_type

string · required

family_id

integer | null · required

creator_id

integer | null · required

uuid

string · required

participant_name

string | null · required

readable_end_time

string · required

readable_start_time

string · required

TransactionResource

id

integer · required

amount

integer · required

Signed integer cents; negative for refunds.

Example: 5000

original_amount

integer · required

Pre-discount amount, in integer cents.

Example: 5000

discount_amount

integer · required

original_amount minus amount, in integer cents.

Example: 0

tax_amount

integer · required

Tax collected, in integer cents.

Example: 0

fees

integer · required

Platform + processing fees, in integer cents.

Example: 175

currency

string · required

ISO 4217 currency code.

Example: usd

type

integer · required

The integer-backed \App\Enums\TransactionType value. See readable_type for its label.

Example: 1

transaction_id

string · required

The Stripe charge id.

Example: ch_1AbCdEfGhIjKlMnO

associated_transaction_id

string | null · required

transaction_id of the original charge this transaction refunds, if any.

Example: ch_1AbCdEfGhIjKlMnO

refund_id

string | null · required

The Stripe refund id, if this transaction is a refund.

Example: re_1AbCdEfGhIjKlMnO

payment_refund_id

string | null · required

The Stripe payment refund id, if applicable.

Example: pyr_1AbCdEfGhIjKlMnO

dispute_transaction_id

string | null · required

transaction_id of the disputed charge, if this transaction is a chargeback.

Example: ch_1AbCdEfGhIjKlMnO

payment_method

string | null · required

Payment method used, e.g. "card" or "interac".

Example: card

pos_transaction

boolean · required

Whether the charge was collected in person via Stripe Terminal (POS).

Example: false

credit_card

string | null · required

Card brand string.

Example: Visa

object · required

Descriptive details recorded with the transaction, such as a description, refund reason, notes or cheque number. Only the keys listed here are returned.

Example: {"description":"Membership renewal","cheque_number":"42"}

created_at

string · required

effective_at

string | null · required

The timestamp the transaction is effective as of (used for reporting/sorting).

Example: 2026-01-15T18:32:00.000000Z

readable_type

string | null · required

Human-readable label for the type enum value.

Example: Charge

readable_created_at

string · required

Human-readable, tenant-timezone formatted creation date.

Example: Jan 15, 2026

item_summary

string · required

Human-readable summary of what was purchased.

Example: Membership for Adult (Monthly)

net_amount

integer · required

net_amount = amount - fees + tax_amount, in integer cents.

Example: 4825

net_fees

integer · required

Fees net of any related refund, in integer cents.

Example: 175

remaining_to_refund

integer · required

Amount still refundable, in integer cents.

Example: 5000

has_dispute

boolean · required

Whether the payment has been disputed. Only reliable when the transaction is returned as part of a program signup; elsewhere it may be false or missing even when a dispute exists, so don't rely on it on its own.

Example: false

associated_bookings

integer[] · required

Ids of bookings tied to this transaction's invoice.

Example: [42]

associated_booking_requests

integer[] · required

Ids of booking requests tied to this transaction's invoice.

Example: []

owner

object | null · required

Minimal owner (frontend only needs email/name/id). Owner may be an Account, Guest, or Organization, and email is nullable on those.

Example: {"id":7,"user_id":7,"email":"member@example.com","name":"Jane Doe"}

invoice

object | null

Minimal invoice with bookings; present when invoice or nativeInvoice is loaded.

Example: {"id":12,"stripe_invoice_number":"INV-0012","exposed_invoice_number":"INV-0012","provenance":"stripe","uuid":"9c1b3f2a-...","bookings":[{"id":42,"starting_at":"2026-01-15T18:00:00.000000Z","readable_start_time":"6:00 PM","bookable_entity":{"name":"Court 1"}}]}

associated_transaction

object | null

Minimal associated transaction so refunds can link back to the original charge's invoice and bookings; only present when the associatedTransaction relation is loaded.

Example: {"id":9,"invoice":{"id":12,"stripe_invoice_number":"INV-0012","exposed_invoice_number":"INV-0012","provenance":"stripe","uuid":"9c1b3f2a-...","bookings":[{"id":42,"starting_at":"2026-01-15T18:00:00.000000Z","readable_start_time":"6:00 PM"}]}}

object

Promotion code with coupon info; only present when the promotionCode relation is loaded.

Example: {"id":3,"name":"SUMMER10","coupon":{"id":5,"name":"10% Off","percent_off":10,"amount_off":null}}

array | null

Tags attached to this transaction. Optional/absent field: only present on the index endpoint with include=tags; the key is entirely absent otherwise, including on the show endpoint, which does not support include.

Example: [{"id":1,"name":"Offline","is_system":true}]

object[]

Minimal transaction line items (avoids expensive Program appends); only present when the transactionLineItems relation is loaded. transaction_line_itemable is a minimal id/name pair for the purchased item (e.g. a Program or Product).

Example: [{"id":88,"quantity":1,"item_name":"Adult Registration","amount":5000,"tax_amount":0,"transaction_line_itemable":{"id":4,"name":"Youth Basketball"}}]

UpdateUserRequest

first_name

string · maxLength: 255 · required

The first name of the user.

last_name

string · maxLength: 255 · required

The last name of the user.

email

string · email · required

A unique email address for the user.

name

string | null

The full name of the user (generated from first/last name).

middle_name

string | null · maxLength: 255

The middle name of the user.

preferred_name

string | null · maxLength: 255

The preferred name of the user.

date_of_birth

string | null · date-time

The date of birth of the user.

profile_city

string | null

The city of the user.

profile_zip

string | null

The postal code or zip code of the user.

profile_state

string | null

The province or state of the user.

profile_address

string | null

The street address of the user.

profile_address_line_2

string | null

The second line of the address of the user.

profile_country

string | null

The ISO 3166-1 alpha-2 country code of the user.

telephone

string | null

A phone number for the user.

object

User

id

integer · required

tenant_id

integer | null · required

name

string · required

first_name

string | null · required

last_name

string | null · required

middle_name

string | null · required

preferred_name

string | null · required

date_of_birth

string | null · date-time · required

email

string · required

email_locked

boolean · required

requires_password_reset

boolean · required

photo_url

string | null · required

uses_two_factor_auth

boolean · required

current_team_id

integer | null · required

stripe_id

string | null · required

current_billing_plan

string | null · required

billing_state

string | null · required

vat_id

string | null · required

trial_ends_at

string | null · date-time · required

last_read_announcements_at

string | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

work_phone

string | null · required

profile_address

string | null · required

profile_address_line_2

string | null · required

profile_city

string | null · required

profile_state

string | null · required

profile_zip

string | null · required

profile_country

string | null · required

family_id

integer | null · required

manager

boolean · required

places_id

string | null · required

status

integer · required

telephone

string | null · required

timezone

string | null · required

deleted_timestamp

string | null · date-time · required

member_id

string | null · required

card_id

string | null · required

business_name

string | null · required

account_id

integer | null · required

can_use_card

boolean · required

is_communal_admin

boolean · required

referrer

string | null · required

anonymized_at

string | null · date-time · required

invoice_number_prefix

string | null · required

invoice_number_starting_at

integer | null · required

profile_photo_path

string | null · required

active

string · enum · required

Enum values:

Active

Inactive

two_factor_enabled

boolean · required

base_membership_plan

null · required

membership_start_date

null · required

readable_membership_start_date

null · required

required

addon_membership_plans

(string | null)[] · required

UserMembershipResource

id

integer · required

The unique identifier of the user membership.

Example: 1234

user_id

integer · required

The id of the member who holds this membership.

Example: 42

status

string · required

Current membership state. retrying means the last renewal payment failed and further attempts are scheduled.

Example: active

will_auto_renew

boolean · required

Whether the membership renews automatically at the end of the current period.

Example: true

ends_at

string | null · required

ISO 8601 timestamp of when the current membership period ends.

Example: 2026-12-31T23:59:59.000000Z

renewed_at

string | null · required

ISO 8601 timestamp of the most recent renewal, or null if the membership has never renewed.

Example: 2026-01-01T00:00:00.000000Z

created_at

string | null · required

ISO 8601 timestamp of when the membership was created.

Example: 2025-06-15T14:30:00.000000Z

object

The membership type this membership belongs to. Included when the relation is loaded, which both endpoints always do.

plan

object | null

The pricing plan the membership is billed on. Included when the relation is loaded, which both endpoints always do. amount is in the smallest currency unit (e.g. cents).

UserResource

id

string · required

name

string · required

email

string · required

profile_photo_url

string · required

date_of_birth

string | null · required

telephone

string

first_name

string

middle_name

string

last_name

string

preferred_name

string

created_at

string | null

updated_at

string | null

subscriptions

string

FamilyMember[]

UserRole

id

integer · required

name

string · required

guard_name

string · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

tenant_id

integer | null · required

UserUploadedFile

id

integer · required

tenant_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

name

string · required

url

string · required

fileable_id

integer | null · required

fileable_type

string · required

deleted_at

string | null · date-time · required

public

boolean · required

s3_deleted_at

string | null · required

apply_to_recurrences

boolean · required

internal_url

string · required

public_url

string · required

signed_url

null · required

signed_url_expires_at

null · required

size

integer | null · required

Waiver

id

integer · required

tenant_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

title

string · required

file

string · required

array · required

publicUrl

string · required

WaiverAssignment

id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

program_id

integer | null · required

membership_type_id

integer | null · required

waiver_id

integer · required

tenant_id

integer | null · required

volunteer_opportunity_id

integer | null · required

parent_program_id

integer | null · required