Get a program signup

​
Path Parameters
  • program_signup
    Type: string
    required
Query Parameters
  • 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-03-25.

Responses
  • application/json
  • application/json
Request Example for get/program_signups/{program_signup}
curl 'https://api.getcommunal.com/api/program_signups/{program_signup}?include=user%2Cprogram%2Ctransaction' \
  --header 'X-Api-Version: 2026-03-25' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "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"
}

ProgramSignupResource