Registration Opportunity

GET

https://api.getcommunal.com/api

/programs/options

A lightweight list of every registration opportunity, meant for dropdowns and pickers. Each row carries only the fields an option list needs, with no related records or pricing. Prefer this over the full list endpoint when you only need names and ids.

filter[parent_program_id]

integer

Filter to registration opportunities under this program.

filter[archived_at]

string

Filter by archived status. Pass empty string to exclude archived registration opportunities.

filter[deleted_at]

string

Filter by deleted status. Pass empty string to exclude deleted registration opportunities.

filter[query]

string

Search registration opportunities by name (partial match).

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Paginated set of RegistrationOpportunityOptionResource

RegistrationOpportunityOptionResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

List registration opportunities

GET

https://api.getcommunal.com/api

/programs

Returns a paginated list of registration opportunities with optional filtering.

List registration opportunities › query Parameters

filter[parent_program_id]

integer

Filter by program ID.

filter[status]

string

Filter by status. Supports multiple comma-separated values. Options: active, upcoming, past, ongoing, archived.

filter[query]

string

Search registration opportunities by name (partial match).

filter[with_participants]

boolean

Filter to only registration opportunities that have participants.

filter[can_register]

boolean

Filter to only registration opportunities the authenticated user can register for.

filter[upcoming]

boolean

Filter to only upcoming registration opportunities.

filter[past]

boolean

Filter to only past registration opportunities.

filter[archived_at]

string

Filter by archived status. Pass empty string to exclude archived registration opportunities.

filter[deleted_at]

string

Filter by deleted status. Pass empty string to exclude deleted registration opportunities.

include

string

Include related resources (comma-separated). Options: signups, parentProgram, waitlistSignups, attendanceSheets, occurrences.

append

string

Append computed attributes (comma-separated). Options: audience, signup_count.

sort

string

Sort results by field. Prefix with - for descending. Options: id, registration_start_date, registration_end_date, event_start_date, event_end_date, created_at.

List registration opportunities › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List registration opportunities › Responses

Paginated set of RegistrationOpportunityResource

RegistrationOpportunityResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

GET/programs

curl https://api.getcommunal.com/api/programs \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 42,
      "display_order": 0,
      "is_pinned": true,
      "name": "Youth Basketball Camp",
      "description": "A fun week-long basketball camp for ages 8-12.",
      "parent_program_id": 5,
      "can_manage_registration_opportunity": true,
      "class_limit": 25,
      "event_start_date": "2025-07-01T09:00:00.000000Z",
      "event_end_date": "2025-07-05T16:00:00.000000Z",
      "registration_start_date": "2025-05-01T00:00:00.000000Z",
      "registration_end_date": "2025-06-25T23:59:59.000000Z",
      "registration_open_until_event_start": true,
      "readable_event_start_date": "July 1, 2025",
      "readable_event_end_date": "July 5, 2025",
      "readable_registration_start_date": "May 1, 2025",
      "readable_registration_end_date": "June 25, 2025",
      "event_start_time": "09:00:00",
      "event_end_time": "16:00:00",
      "readable_event_start_time": "9:00 AM",
      "readable_event_end_time": "4:00 PM",
      "status": "active",
      "ongoing": false,
      "archived_at": "2025-01-30T18:00:00.000000Z",
      "deleted_at": "2025-01-25T12:00:00.000000Z",
      "waitlist_enabled": true,
      "exclude_from_reminder_emails": false,
      "is_priority_waitlist_locked": false,
      "multiple_signups": false,
      "display_to_all_users": true,
      "hide_from_non_buyers": false,
      "dob_validation": true,
      "min_date_of_birth": "2017-12-31",
      "max_date_of_birth": "2013-01-01",
      "program_prices": [
        {
          "price": 7500,
          "label": "Member"
        },
        {
          "price": 10000,
          "label": "Non-Member"
        }
      ],
      "free": false,
      "ignore_gst": false,
      "product_id": "prod_abc123",
      "registration_start_time": "00:00:00",
      "registration_end_time": "23:59:59",
      "is_event": false,
      "prompt_for_registrant": false,
      "prompt_for_number_of_guests": false,
      "force_additional_member_info": false,
      "allow_file_uploads": false,
      "file_uploads_required": false,
      "file_uploads_max": 5,
      "pay_by_cash": true,
      "collect_additional_information": false,
      "form_id": 15,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-20T14:45:00.000000Z",
      "member_savings": 1000,
      "price_for_user": 7500,
      "num_signups_remaining_for_user": 2,
      "lowest_price_excluded": 5000,
      "highest_price": 15000,
      "signup_count": 18,
      "is_full": false,
      "spots_remaining": 7,
      "user_signup_count": 1,
      "volunteer_price": 5000,
      "volunteer_price_is_free": true,
      "price_id_for_user": "price_abc123",
      "required_membership_id_for_user": "prod_abc123",
      "price_recurs_for_user": true,
      "price_interval_for_user": "month",
      "price_interval_count_for_user": 1,
      "can_user_purchase": true,
      "required_membership_names": [
        "Base Membership",
        "Premium Membership"
      ],
      "signups": "signups",
      "parent_program": "parent_program",
      "prices": "prices",
      "metadata": "metadata",
      "waivers": "waivers",
      "waitlist_signups": "waitlist_signups",
      "attendance_sheets": "attendance_sheets",
      "occurrences": "occurrences",
      "recurrence_rule": "recurrence_rule"
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Create registration opportunity

POST

https://api.getcommunal.com/api

/programs

Create a registration opportunity under an existing program. Requires the programs:write API key scope and a manager role or an Instructor assigned to that program. Dates and times use the organization timezone.

Create registration opportunity › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Create registration opportunity › Request Body

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

Create registration opportunity › Responses

Program

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

POST/programs

curl https://api.getcommunal.com/api/programs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "description": "description",
  "class_limit": 0,
  "prices": [
    "string"
  ],
  "display_to_all_users": "display_to_all_users",
  "min_date_of_birth": "2024-08-25",
  "max_date_of_birth": "2024-08-25",
  "ongoing": true,
  "event_start_date": "2024-08-25T15:00:00Z",
  "event_end_date": "2024-08-25T15:00:00Z",
  "registration_start_date": "2024-08-25T15:00:00Z",
  "registration_end_date": "2024-08-25T15:00:00Z",
  "registration_open_until_event_start": true,
  "parent_program_id": 0,
  "waitlist_enabled": true,
  "exclude_from_reminder_emails": true,
  "dob_validation": true,
  "hide_from_non_buyers": true,
  "allow_file_uploads": true,
  "file_uploads_required": true,
  "file_uploads_max": 1
}'

Example Request Body

{
  "name": "name",
  "description": "description",
  "class_limit": 0,
  "prices": [
    "string"
  ],
  "display_to_all_users": "display_to_all_users",
  "min_date_of_birth": "2024-08-25",
  "max_date_of_birth": "2024-08-25",
  "ongoing": true,
  "event_start_date": "2024-08-25T15:00:00Z",
  "event_end_date": "2024-08-25T15:00:00Z",
  "registration_start_date": "2024-08-25T15:00:00Z",
  "registration_end_date": "2024-08-25T15:00:00Z",
  "registration_open_until_event_start": true,
  "parent_program_id": 0,
  "waitlist_enabled": true,
  "exclude_from_reminder_emails": true,
  "dob_validation": true,
  "hide_from_non_buyers": true,
  "allow_file_uploads": true,
  "file_uploads_required": true,
  "file_uploads_max": 1
}

json

Example Responses

{
  "id": 5,
  "title": "Summer Sports Programs",
  "description": "A collection of exciting summer sports programs for all ages.",
  "event_start_date": "2025-06-01T12:00:00.000000Z",
  "event_end_date": "2025-08-31T15:00:00.000000Z",
  "registration_start_date": "2025-01-01T12:00:00.000000Z",
  "registration_end_date": "2025-02-03T12:00:00.000000Z",
  "ongoing": false,
  "status": "active",
  "dates": "June 1 - August 31, 2025",
  "registration_dates": "May 1 - May 31, 2025",
  "is_event": false,
  "draft": false,
  "is_hidden": false,
  "profile_image": "https://example.com/images/summer-sports.jpg",
  "limit": 120,
  "total_spots": 120,
  "available_spots": 34,
  "total_signups": 86,
  "reserved_spots": 60,
  "reserved_spots_signups": 44,
  "reserved_spots_remaining": 16,
  "uncapped_spots": 60,
  "uncapped_spots_signups": 42,
  "uncapped_spots_remaining": 18,
  "demographic": "Youth (Ages 8-12)",
  "instructor": "Jane Coach",
  "location_name": "Main Gymnasium",
  "location_address": "123 Main St, Springfield, IL",
  "location_latitude": 43.6532,
  "location_longitude": -79.3832,
  "is_online": false,
  "readable_event_start_date": "Thu, Jun 1, 2025 7:00 PM",
  "readable_event_end_date": "Sat, Aug 31, 2025 5:00 PM",
  "event_start_time": "19:00",
  "event_end_time": "17:00",
  "registration_start_time": "09:00",
  "registration_end_time": "23:59",
  "display_only": false,
  "unsplash_author_name": "Alex Photographer",
  "unsplash_author_link": "https://unsplash.com/@alex",
  "multiple_signups": false,
  "prompt_for_number_of_guests": true,
  "prompt_for_registrant": true,
  "waitlist_enabled": true,
  "force_participant_selection": false,
  "show_participant_list": true,
  "hide_participant_details": false,
  "pay_by_cash": false,
  "registration_fee": 2500,
  "cap_registration_fee": false,
  "ignores_tax_rates": false,
  "collection_additional_information": true,
  "require_emergency_contact_information": true,
  "block_facility_calendars": false,
  "auto_archive": true,
  "auto_archive_days": 0,
  "participant_must_hold_membership": false,
  "form_id": 42,
  "allow_file_uploads": true,
  "file_uploads_required": false,
  "file_uploads_max": 3,
  "volunteer_opportunities_ids": [
    3,
    7,
    11
  ],
  "facility_ids": [
    2,
    5
  ],
  "sort_order": 0,
  "manual_order_enabled": false,
  "gl_code": "4000-100",
  "created_at": "2025-01-15T10:30:00.000000Z",
  "updated_at": "2025-01-20T14:45:00.000000Z",
  "deleted_at": "2025-01-25T12:00:00.000000Z",
  "archived_at": "2025-01-30T18:00:00.000000Z",
  "facilities": "facilities",
  "registration_opportunities": "registration_opportunities",
  "member_pricing_savings": {
    "name": "Gold Membership",
    "guest_price": 4500,
    "price": 3500,
    "savings": 1000
  },
  "volunteer_opportunities": "volunteer_opportunities",
  "waiver_assignments": "waiver_assignments",
  "tags": "tags"
}

json

application/json

Get a registration opportunity

GET

https://api.getcommunal.com/api

/programs/{program}

Get a registration opportunity › path Parameters

program

string · required

Get a registration opportunity › query Parameters

include

string

Include related resources (comma-separated). Options: metadata, prices, prices.membership, prices.plan, prices.schedule_config, signups, parentProgram, waitlistSignups, attendanceSheets, occurrences, recurrenceRule.

append

string

Append computed attributes (comma-separated). Options: signup_count.

Get a registration opportunity › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Get a registration opportunity › Responses

RegistrationOpportunityResource

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, display_order, is_pinned +49 more
	type = null

Properties for RegistrationOpportunityResource:

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.

GET/programs/{program}

curl https://api.getcommunal.com/api/programs/:program \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 42,
  "display_order": 0,
  "is_pinned": true,
  "name": "Youth Basketball Camp",
  "description": "A fun week-long basketball camp for ages 8-12.",
  "parent_program_id": 5,
  "can_manage_registration_opportunity": true,
  "class_limit": 25,
  "event_start_date": "2025-07-01T09:00:00.000000Z",
  "event_end_date": "2025-07-05T16:00:00.000000Z",
  "registration_start_date": "2025-05-01T00:00:00.000000Z",
  "registration_end_date": "2025-06-25T23:59:59.000000Z",
  "registration_open_until_event_start": true,
  "readable_event_start_date": "July 1, 2025",
  "readable_event_end_date": "July 5, 2025",
  "readable_registration_start_date": "May 1, 2025",
  "readable_registration_end_date": "June 25, 2025",
  "event_start_time": "09:00:00",
  "event_end_time": "16:00:00",
  "readable_event_start_time": "9:00 AM",
  "readable_event_end_time": "4:00 PM",
  "status": "active",
  "ongoing": false,
  "archived_at": "2025-01-30T18:00:00.000000Z",
  "deleted_at": "2025-01-25T12:00:00.000000Z",
  "waitlist_enabled": true,
  "exclude_from_reminder_emails": false,
  "is_priority_waitlist_locked": false,
  "multiple_signups": false,
  "display_to_all_users": true,
  "hide_from_non_buyers": false,
  "dob_validation": true,
  "min_date_of_birth": "2017-12-31",
  "max_date_of_birth": "2013-01-01",
  "program_prices": [
    {
      "price": 7500,
      "label": "Member"
    },
    {
      "price": 10000,
      "label": "Non-Member"
    }
  ],
  "free": false,
  "ignore_gst": false,
  "product_id": "prod_abc123",
  "registration_start_time": "00:00:00",
  "registration_end_time": "23:59:59",
  "is_event": false,
  "prompt_for_registrant": false,
  "prompt_for_number_of_guests": false,
  "force_additional_member_info": false,
  "allow_file_uploads": false,
  "file_uploads_required": false,
  "file_uploads_max": 5,
  "pay_by_cash": true,
  "collect_additional_information": false,
  "form_id": 15,
  "created_at": "2025-01-15T10:30:00.000000Z",
  "updated_at": "2025-01-20T14:45:00.000000Z",
  "member_savings": 1000,
  "price_for_user": 7500,
  "num_signups_remaining_for_user": 2,
  "lowest_price_excluded": 5000,
  "highest_price": 15000,
  "signup_count": 18,
  "is_full": false,
  "spots_remaining": 7,
  "user_signup_count": 1,
  "volunteer_price": 5000,
  "volunteer_price_is_free": true,
  "price_id_for_user": "price_abc123",
  "required_membership_id_for_user": "prod_abc123",
  "price_recurs_for_user": true,
  "price_interval_for_user": "month",
  "price_interval_count_for_user": 1,
  "can_user_purchase": true,
  "required_membership_names": [
    "Base Membership",
    "Premium Membership"
  ],
  "signups": "signups",
  "parent_program": "parent_program",
  "prices": "prices",
  "metadata": "metadata",
  "waivers": "waivers",
  "waitlist_signups": "waitlist_signups",
  "attendance_sheets": "attendance_sheets",
  "occurrences": "occurrences",
  "recurrence_rule": "recurrence_rule"
}

json

application/json

Attendance Record ProgramOrder

Registration Opportunity

List registration opportunities as slim dropdown options

List registration opportunities as slim dropdown options › query Parameters

List registration opportunities as slim dropdown options › Headers

List registration opportunities as slim dropdown options › Responses

List registration opportunities

List registration opportunities › query Parameters

List registration opportunities › Headers

List registration opportunities › Responses

Create registration opportunity

Create registration opportunity › Headers

Create registration opportunity › Request Body

Create registration opportunity › Responses

Get a registration opportunity

Get a registration opportunity › path Parameters

Get a registration opportunity › query Parameters

Get a registration opportunity › Headers

Get a registration opportunity › Responses

Decision Table