Soljio Organization API
Organization-scoped domain reads, commands and tracked jobs. See docs/api/coverage.json for source mappings and explicit exceptions. Family self-service and platform administration are outside this contract. Service tokens select exactly one organization. No organization override is accepted.
Version 0.1.0
Base URL
https://api.soljio.com/v0organizations
Organization operations.
- GETList organizations
/organizations - HEADCheck List organizations
/organizations - GETGet organization
/organizations/{id} - HEADCheck Get organization
/organizations/{id}
locations
Location operations.
- GETList locations
/locations - HEADCheck List locations
/locations - GETGet location
/locations/{id} - HEADCheck Get location
/locations/{id}
programs
Program operations.
- GETList programs
/programs - HEADCheck List programs
/programs - GETGet program
/programs/{id} - HEADCheck Get program
/programs/{id}
offerings
Offering operations.
- GETList offerings
/offerings - HEADCheck List offerings
/offerings - GETGet offering
/offerings/{id} - HEADCheck Get offering
/offerings/{id}
sessions
Session operations.
- GETList sessions
/sessions - HEADCheck List sessions
/sessions - GETGet session
/sessions/{id} - HEADCheck Get session
/sessions/{id} - POSTPreview additional offering dates
/commands/preview_offering_schedule - POSTApply a reviewed schedule preview
/commands/apply_offering_schedule
participants
Participant operations.
- GETList participants
/participants - HEADCheck List participants
/participants - GETGet participant
/participants/{id} - HEADCheck Get participant
/participants/{id}
enrollments
Enrollment operations.
- GETList enrollments
/enrollments - HEADCheck List enrollments
/enrollments - GETGet enrollment
/enrollments/{id} - HEADCheck Get enrollment
/enrollments/{id} - POSTCreate an enrollment
/commands/create_enrollment - POSTCancel an enrollment
/commands/cancel_enrollment
organization-commands
Shared organization domain commands.
- POSTAdd a signed credit or charge with a reason to an open invoice.
/commands/add_invoice_adjustment - POSTAdd a holiday to a term after reviewing a preview; class dates in the term on that day are cancelled and their families notified.
/commands/add_term_holiday - POSTPreview: Add a holiday to a term after reviewing a preview; class dates in the term on that day are cancelled and their families notified.
/commands/preview_add_term_holiday - POSTAccept a family's requested lesson change, moving the lessons if the times are still open, or decline it.
/commands/answer_private_lesson_change - POSTApply a validated batch of parsed CSV rows; inspect returned row issues and batch status.
/commands/apply_import - POSTApprove or decline a private lesson request waiting on the school.
/commands/approve_private_lesson_booking - POSTArchive an offering.
/commands/archive_offering - POSTArchive a program after its current offerings are archived.
/commands/archive_program - POSTAssign or unassign organization work to an active staff member.
/commands/assign_action - POSTAssign or unassign a conversation to an active organization staff member.
/commands/assign_conversation - POSTCancel a private lesson booking, one lesson, or a lesson and the ones after it after reviewing a preview; returns credits and notifies the family.
/commands/cancel_private_lesson_booking - POSTPreview: Cancel a private lesson booking, one lesson, or a lesson and the ones after it after reviewing a preview; returns credits and notifies the family.
/commands/preview_cancel_private_lesson_booking - POSTCancel a class date and release its resources.
/commands/cancel_session - POSTPreview: Cancel a class date and release its resources.
/commands/preview_cancel_session - POSTChange which of the family's students attend upcoming lessons at the price difference quote_private_lesson_roster_change returned.
/commands/change_private_lesson_roster - POSTUse a makeup credit only when a confirmed destination seat can be created in the same write.
/commands/consume_makeup_credit - POSTGo ahead with a booking waiting on guests without some of them, at the amount quote_private_lesson_without_guests returned.
/commands/continue_private_lesson_without_guests - POSTAdd an active instructor by name. Link the school account they teach as with update_instructor.
/commands/create_instructor - POSTAdd a registration question to a program.
/commands/create_intake_question - POSTCreate an invoice from eligible enrollment balances.
/commands/create_invoice - POSTCreate an offering with validated commercial terms and optional initial schedule.
/commands/create_offering - POSTPreview: Create an offering with validated commercial terms and optional initial schedule.
/commands/preview_create_offering - POSTCreate a participant and optional household; queue new household access invitations.
/commands/create_participant - POSTBook private lessons for a family at the totals quote_private_lesson returned, after reviewing a preview; invites guests and notifies the family.
/commands/create_private_lesson_booking - POSTPreview: Book private lessons for a family at the totals quote_private_lesson returned, after reviewing a preview; invites guests and notifies the family.
/commands/preview_create_private_lesson_booking - POSTCreate a program.
/commands/create_program - POSTCreate a promo code.
/commands/create_promo_code - POSTCreate a scheduled class date.
/commands/create_session - POSTPreview: Create a scheduled class date.
/commands/preview_create_session - POSTCreate a term: a named season with a start date and optional end date.
/commands/create_term - POSTRemove a custom domain from hosting and disable tenant routing.
/commands/disable_custom_domain - POSTClose the connected Stripe account and disable online payments.
/commands/disconnect_payment_connection - POSTValidate a batch of parsed CSV rows without applying changes.
/commands/dry_run_import - POSTCreate a staff invitation and queue its email. The acceptance credential is never returned.
/commands/invite_staff - POSTIssue a makeup credit using the same eligibility rules as staff operations.
/commands/issue_makeup_credit - POSTMark every unmarked student on a class date present.
/commands/mark_all_present - POSTRecord attendance for an enrollment or makeup participant.
/commands/mark_attendance - POSTMove a program registration question up or down.
/commands/move_intake_question - POSTMove upcoming confirmed lessons of a booking to new times or instructors after reviewing a preview; notifies the family.
/commands/move_private_lessons - POSTPreview: Move upcoming confirmed lessons of a booking to new times or instructors after reviewing a preview; notifies the family.
/commands/preview_move_private_lessons - POSTRender the current notification template with sample content; poll get_job for the message.
/commands/preview_notification_template - POSTPromote the next eligible waitlisted enrollment when capacity permits.
/commands/promote_waitlist - POSTPublish an organization notification template.
/commands/publish_notification_template - POSTRecord review of a payment provider state discrepancy.
/commands/reconcile_provider_state - POSTRecord evidence of recipient notification consent.
/commands/record_notification_consent - POSTRecord a payment collected outside the payment provider. Available on the Pro and Scale plans.
/commands/record_offline_payment - POSTRecord an offline refund without exceeding the refundable balance.
/commands/record_offline_refund - POSTRecord a student's attendance at a private lesson.
/commands/record_private_lesson_attendance - POSTRecord an offline refund for a lesson pack and remove unused credits.
/commands/record_private_lesson_pack_refund - POSTRecord a lesson pack sold to a family and paid outside the payment provider. Paid packs require the Pro or Scale plan.
/commands/record_private_lesson_pack_sale - POSTRecord a private lesson booking payment collected outside the payment provider. Available on the Pro and Scale plans.
/commands/record_private_lesson_payment - POSTRecord an offline refund of money owed back on a private lesson booking.
/commands/record_private_lesson_refund - POSTCheck custom domain verification and routing.
/commands/refresh_custom_domain - POSTRemove a holiday from a term. Class dates already cancelled for it stay cancelled.
/commands/remove_term_holiday - POSTReplace the future schedule with reviewed dates and recurring rules.
/commands/replace_offering_schedule - POSTPreview: Replace the future schedule with reviewed dates and recurring rules.
/commands/preview_replace_offering_schedule - POSTRequest a custom domain; poll get_job and list_custom_domains for DNS verification.
/commands/request_custom_domain - POSTQueue a refund of money owed on a private lesson booking to the cards it was paid with; payment reconciliation issues it.
/commands/request_private_lesson_card_refund - POSTQueue a card refund for a lesson pack bought online and remove unused credits; payment reconciliation issues it.
/commands/request_private_lesson_pack_card_refund - POSTStart a report job; poll get_report, then paginate get_report_rows.
/commands/request_report - POSTReplace an invitation and queue its email.
/commands/resend_staff_invitation - POSTReset a notification template to its system default.
/commands/reset_notification_template - POSTRemove a recipient block after explicit confirmation; consent and preferences still apply.
/commands/revoke_notification_suppression - POSTRevoke a pending staff invitation.
/commands/revoke_staff_invitation - POSTSet weekly private lesson hours and date exceptions for a location, instructor or resource.
/commands/save_private_lesson_availability - POSTCreate or update a lesson pack families can buy.
/commands/save_private_lesson_pack_type - POSTCreate or update a private lesson type with its pricing, rules, locations and instructors.
/commands/save_private_lesson_type - POSTQueue a household account invitation using recipient eligibility and resend limits.
/commands/send_household_claim - POSTActivate or archive an instructor.
/commands/set_instructor_status - POSTArchive or restore a program registration question.
/commands/set_intake_question_archived - POSTSet an organization notification preference.
/commands/set_notification_preference - POSTUpdate recipient notification suppression.
/commands/set_notification_suppression - POSTReplace the instructors assigned to an offering.
/commands/set_offering_instructors - POSTActivate or deactivate a promo code.
/commands/set_promo_code_active - POSTMark one skill on a student's checklist as attempted or completed, or clear it. Families see marks on their report card.
/commands/set_skill_mark - POSTSnooze organization work for up to 30 days, or clear its snooze.
/commands/snooze_action - POSTSuppress email delivery to an organization recipient.
/commands/suppress_email_recipient - POSTRefresh the connected Stripe account capabilities.
/commands/sync_payment_connection - POSTTransfer an enrollment to another offering or class date.
/commands/transfer_enrollment - POSTUpdate the sender name, reply-to address and postal address on school email.
/commands/update_email_identity - POSTUpdate an instructor's name, slug or linked school account.
/commands/update_instructor - POSTUpdate a program registration question.
/commands/update_intake_question - POSTUpdate an offering's details, location, capacity, commercial terms or status after reviewing a preview.
/commands/update_offering - POSTPreview: Update an offering's details, location, capacity, commercial terms or status after reviewing a preview.
/commands/preview_update_offering - POSTUpdate organization profile and slug.
/commands/update_organization_profile - POSTUpdate organization profile, timezone and operating defaults.
/commands/update_organization_settings - POSTUpdate a participant profile, household association and provider consent.
/commands/update_participant - POSTUpdate a student's safety details such as swim ability, medical notes and emergency contacts.
/commands/update_participant_safety - POSTUpdate program details or status.
/commands/update_program - POSTUpdate a recurring rule and reconcile future class dates.
/commands/update_recurring_schedule_rule - POSTPreview: Update a recurring rule and reconcile future class dates.
/commands/preview_update_recurring_schedule_rule - POSTChange a class date and its resource assignments.
/commands/update_session - POSTPreview: Change a class date and its resource assignments.
/commands/preview_update_session - POSTSet or clear the sibling discount.
/commands/update_sibling_discount - POSTChange a non-owner staff membership role. Owner access requires a human owner.
/commands/update_staff_role - POSTActivate or remove a non-owner membership. Organization credentials survive creator removal.
/commands/update_staff_status - POSTReplace the school's swim ability levels.
/commands/update_swim_ability_levels - POSTUpdate a term's name, dates or status.
/commands/update_term - POSTCreate or update a location.
/commands/upsert_location - POSTCreate or update an organization report-card template.
/commands/upsert_report_card_template - POSTCreate or update an organization resource.
/commands/upsert_resource - POSTVoid an unpaid invoice.
/commands/void_invoice - POSTVoid an incorrectly recorded offline payment.
/commands/void_offline_payment
organization-reads
Organization read models and filtered views.
- GETGet asynchronous operation status and result; also requires the operation’s original scope.
/jobs/{id} - HEADCheck Get asynchronous operation status and result; also requires the operation’s original scope.
/jobs/{id} - POSTExport data.
/queries/export_data - POSTGet catalog overview.
/queries/get_catalog_overview - POSTGet class date details.
/queries/get_class_date_details - POSTGet conversation.
/queries/get_conversation - POSTGet the published waiver version families currently accept.
/queries/get_current_waiver_version - POSTGet the sibling discount and promo codes.
/queries/get_discount_settings - POSTGet the registration answers families gave for up to 250 enrollments at a time.
/queries/get_enrollment_intake_answers - POSTGet supported CSV column keys, required columns and sample rows for each import kind.
/queries/get_import_templates - POSTGet an invoice with its line items, discounts and adjustments.
/queries/get_invoice - POSTGet invoice workspace.
/queries/get_invoice_workspace - POSTGet asynchronous operation status and result; also requires the operation’s original scope.
/queries/get_job - POSTGet next class date.
/queries/get_next_class_date - POSTGet a message delivery attempt and its bounded transition history.
/queries/get_notification_delivery - POSTGet notification template.
/queries/get_notification_template - POSTGet offering defaults.
/queries/get_offering_defaults - POSTGet offering details.
/queries/get_offering_details - POSTGet offering schedule.
/queries/get_offering_schedule - POSTGet organization work queues; personal dismissals are not available to service actors.
/queries/get_operations_queue - POSTGet organization settings.
/queries/get_organization_settings - POSTGet participant details.
/queries/get_participant_details - POSTGet payment capabilities.
/queries/get_payment_capabilities - POSTGet a private lesson booking with its lessons, family, guests and payments.
/queries/get_private_lesson_booking - POSTGet the card money that can still be refunded on a private lesson booking.
/queries/get_private_lesson_card_refundable - POSTGet a family's students and usable lesson packs for booking on their behalf.
/queries/get_private_lesson_household - POSTGet the card money that can still be refunded for a lesson pack bought online.
/queries/get_private_lesson_pack_card_refundable - POSTGet private lesson types, availability, pack types and the locations, instructors and resources they use.
/queries/get_private_lesson_setup - POSTGet private lesson requests waiting on someone and the lessons in a range of up to two weeks.
/queries/get_private_lessons_overview - POSTGet program details.
/queries/get_program_details - POSTGet a class date's skills checklist: each student's marks on one checklist level.
/queries/get_progress_roster - POSTGet report preparation status and summary.
/queries/get_report - POSTRead a page of completed report rows.
/queries/get_report_rows - POSTGet schedule month summary.
/queries/get_schedule_month - POSTGet schedule week.
/queries/get_schedule_week - POSTGet attendance, makeup and enrollment details for a class date.
/queries/get_session_roster - POSTGet a complete class date roster with registration answers in one snapshot, for export.
/queries/get_session_roster_export - POSTGet sms settings.
/queries/get_sms_settings - POSTGet the school's waiver draft, published version and requirement settings.
/queries/get_waiver_settings - POSTList audit events.
/queries/list_audit_events - POSTList class dates.
/queries/list_class_dates - POSTList conversations.
/queries/list_conversations - POSTList custom domains.
/queries/list_custom_domains - POSTList programs eligible for promo code scope selection.
/queries/list_discount_program_choices - POSTList the registration questions staff must collect when enrolling into offerings.
/queries/list_enrollment_intake_questions - POSTList the payments recorded against enrollments, with their processor references.
/queries/list_enrollment_payments - POSTList household participants.
/queries/list_household_participants - POSTList import batches.
/queries/list_import_batches - POSTList instructors, newest first, with their status and linked school account.
/queries/list_instructors - POSTList location options.
/queries/list_location_options - POSTList message delivery attempts and recipient addresses.
/queries/list_notification_deliveries - POSTList blocked recipients and their message scopes.
/queries/list_notification_suppressions - POSTList notification templates.
/queries/list_notification_templates - POSTList offering options.
/queries/list_offering_options - POSTList participant profiles.
/queries/list_participant_profiles - POSTList whether students have a current signed waiver.
/queries/list_participant_waiver_statuses - POSTList payment provider states.
/queries/list_payment_provider_states - POSTList payment webhooks.
/queries/list_payment_webhooks - POSTList instructor private lesson hours where lesson types let instructors maintain their own availability.
/queries/list_private_lesson_instructor_hours - POSTList lesson packs sold to families, newest first, with balances.
/queries/list_private_lesson_packs - POSTList bookable private lesson start times per day for up to six weeks.
/queries/list_private_lesson_slots - POSTList every private lesson type staff can book, published or not.
/queries/list_private_lesson_types - POSTList a program's registration questions, including archived ones.
/queries/list_program_intake_questions - POSTList program options.
/queries/list_program_options - POSTList report cards: the skills checklists students are marked against.
/queries/list_report_card_templates - POSTList resources.
/queries/list_resources - POSTList schedule rules.
/queries/list_schedule_rules - POSTList credential metadata without secrets.
/queries/list_service_tokens - POSTList eligible class dates for an enrollment transfer or makeup credit.
/queries/list_session_operation_targets - POSTList active school members an instructor can be linked to.
/queries/list_teaching_accounts - POSTList terms with their dates, status and holidays.
/queries/list_terms - POSTExpand a weekly or fortnightly private lesson series into dates, with alternatives for dates that can't be booked.
/queries/plan_private_lesson_series - POSTPrice a private lesson booking exactly as create_private_lesson_booking will.
/queries/quote_private_lesson - POSTPrice changing which students attend upcoming lessons before change_private_lesson_roster.
/queries/quote_private_lesson_roster_change - POSTPrice going ahead with a booking without some invited guests before continue_private_lesson_without_guests.
/queries/quote_private_lesson_without_guests - POSTSearch enrollment and balance details.
/queries/search_enrollments - POSTSearch offerings.
/queries/search_offerings - POSTSearch organization.
/queries/search_organization - POSTSearch participants.
/queries/search_participants - POSTSearch programs.
/queries/search_programs