List program signups

​
Query Parameters
  • filter[program_id]
    Type: string

    Filter by registration opportunity ID. Supports comma-separated values for multiple registration opportunities.

  • filter[program[parent_program_id]]
    Type: integer

    Filter by program ID. Returns signups for all registration opportunities under this program.

  • filter[user_id]
    Type: integer

    Filter by user ID. Non-managers can only filter to their own ID.

  • filter[query]
    Type: string

    Search by registration opportunity name, user name, user email, guest name, additional member name, or guest email.

  • filter[status]
    Type: string

    Filter by registration opportunity time status. Supports multiple comma-separated values. Options: ongoing, upcoming, past.

  • filter[timeScope]
    Type: string

    Simple time scope filter. Options: upcoming (includes ongoing and active), past, all.

  • filter[event_start_date]
    Type: string

    Filter by registration opportunity event date range. Pass as array: filter[event_start_date][0]=start&filter[event_start_date][1]=end. Includes ongoing registration opportunities.

  • filter[upcoming]
    Type: boolean

    Filter to signups for upcoming registration opportunities only.

  • filter[past]
    Type: boolean

    Filter to signups for past registration opportunities only.

  • filter[ongoing]
    Type: boolean

    Filter to signups for ongoing registration opportunities only.

  • filter[withTrashed]
    Type: boolean

    Include soft-deleted signups. Defaults to excluding deleted.

  • filter[program[archived_at]]
    Type: string

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

  • filter[program[deleted_at]]
    Type: string

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

  • include
    Type: string

    Include related resources (comma-separated). Options: additionalMember, additionalMember.emergency, files, guest, program, program.parentProgram, transaction, user, user.family, user.family.emergency, formSubmissions, subscriptionSchedule.config.configurable, subscriptionSchedule.paymentsReceived, attendanceRecords.

Headers
  • X-Api-Version
    Type: string

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

Responses
  • application/json
  • application/json
Request Example for get/program_signups
curl 'https://api.getcommunal.com/api/program_signups?filter[program_id]=1%2C2%2C3&filter[program[parent_program_id]]=5&filter[user_id]=42&filter[query]=john&filter[status]=ongoing%2Cupcoming&filter[timeScope]=upcoming&filter[event_start_date]=2025-01-01&filter[upcoming]=true&filter[past]=true&filter[ongoing]=true&filter[withTrashed]=true&filter[program[archived_at]]=&filter[program[deleted_at]]=&include=user%2Cprogram' \
  --header 'X-Api-Version: 2026-02-01' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": 156,
      "program_id": 42,
      "user_id": 89,
      "guest_id": null,
      "additional_member_id": null,
      "transaction_id": 1234,
      "subscription_schedule_id": 7,
      "ticket_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "product_id": "prod_abc123",
      "payment_method": "credit_card",
      "paid": 1,
      "amount_paid": 75,
      "amount_refunded": 0,
      "number_of_guests": 0,
      "quantity": 1,
      "associated_email": "john.doe@example.com",
      "associated_name": "John Doe",
      "associated_address": "123 Main St, Toronto, ON",
      "associated_telephone": "416-555-1234",
      "participant_name": "Johnny Doe",
      "participant_dob": "2015-03-15",
      "additional_member_name": null,
      "additional_member_dob": "2015-03-15",
      "additional_member_gender_identity": null,
      "additional_member_medical": null,
      "additional_member_emergency_contact": {
        "name": "Jane Doe",
        "phone": "416-555-5678"
      },
      "created_at": "2025-05-20T14:30:00.000000Z",
      "updated_at": "2025-05-20T14:30:00.000000Z",
      "deleted_timestamp": "2025-05-25T10:00:00.000000Z",
      "user": "string",
      "guest": "string",
      "additional_member": "string",
      "program": "string",
      "transaction": "string",
      "files": "string",
      "form_submissions": "string",
      "subscription_schedule": "string",
      "attendance_records": "string",
      "list_of_activities": "Basketball, Soccer, Volleyball"
    }
  ],
  "current_page": 1,
  "from": null,
  "last_page": 1,
  "per_page": 1,
  "to": null,
  "total": 0
}

Paginated set of ProgramSignupResource