Get code availability

get

Authorizations

jwtAuth

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

get

/api/church/get-code-availability

HTTPcURLJavaScriptPython

GET /api/church/get-code-availability HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "plan": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "monthly_free_credits": 1,
    "perks": null,
    "prices": null
  },
  "prayer_request_reviewers": "text",
  "testimony_reviewers": "text",
  "locations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T04:58:08.659Z",
      "updated_at": "2026-02-17T04:58:08.659Z",
      "name": "text",
      "address_1": "text",
      "address_2": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "country": "text",
      "is_default": true,
      "is_main": true,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "follow_up_managers": "text",
  "follow_up_department": "text",
  "give_methods": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T04:58:08.659Z",
      "updated_at": "2026-02-17T04:58:08.659Z",
      "name": "text",
      "details": null,
      "church": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "messaging_numbers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "legacy_id": "text",
      "nextgen_legacy_id": "text",
      "created_at": "2026-02-17T04:58:08.659Z",
      "updated_at": "2026-02-17T04:58:08.659Z",
      "number": "text",
      "friendly_name": "text",
      "released_at": "2026-02-17T04:58:08.659Z",
      "restored_at": "2026-02-17T04:58:08.659Z",
      "purchaser": "123e4567-e89b-12d3-a456-426614174000",
      "releaser": "123e4567-e89b-12d3-a456-426614174000",
      "restorer": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "fee": "text",
  "stripe_public_key": "text",
  "failed_invoice_payment": "text",
  "template_variables": "text",
  "user_count": "text",
  "free_trial_days_left": "text",
  "legacy_id": "text",
  "nextgen_legacy_id": "text",
  "created_at": "2026-02-17T04:58:08.659Z",
  "updated_at": "2026-02-17T04:58:08.659Z",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "short_code": "text",
  "website": "https://example.com",
  "timezone": "text",
  "currency": "text",
  "url": "https://example.com",
  "address_1": "text",
  "address_2": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "country": "text",
  "country_code": "text",
  "socials": null,
  "celebration_types": null,
  "package": "1-100",
  "default_processor": "stripe",
  "processors": null,
  "processor_status": null,
  "prayer_request_restriction": true,
  "prayer_request_push_notifications": true,
  "prayer_request_push_notification_subject": "text",
  "prayer_request_push_notification_body": "text",
  "testimony_restriction": true,
  "testimony_push_notifications": true,
  "testimony_push_notification_subject": "text",
  "testimony_push_notification_body": "text",
  "child_maximum_age": 1,
  "teenager_maximum_age": 1,
  "portal_logo": "text",
  "mobile_logo": "text",
  "landing_logo": "text",
  "statement_logo": "text",
  "primary_color": "text",
  "secondary_color": "text",
  "dark_mode_color": "text",
  "youtube_channel_id": "text",
  "testimony_story_lifetime": 1,
  "enable_give_module_on_landing_page": true,
  "enable_check_in_module_on_landing_page": true,
  "enable_rsvp_module_on_landing_page": true,
  "rsvp_label": "text",
  "enable_livestream_module_on_landing_page": true,
  "user_portal_default_theme_is_dark": true,
  "admin_portal_default_theme_is_dark": true,
  "mobile_portal_default_theme_is_dark": true,
  "allow_users_switch_theme": true,
  "allow_users_change_session_duration": true,
  "allow_geo_based_check_in": true,
  "pastor_name": "text",
  "pastor_title": "text",
  "pastor_hub_app_code": "text",
  "pastor_phone": "text",
  "allow_users_set_spouse": true,
  "allow_users_unset_spouse": true,
  "allow_users_with_same_envelope_id": true,
  "maximum_number_users_with_same_envelope_id": 1,
  "house_fellowship_name_label": "text",
  "house_fellowship_zone_label": "text",
  "house_fellowship_district_label": "text",
  "auto_response_text_message": "text",
  "auto_response_text_message_updated_at": "2026-02-17T04:58:08.659Z",
  "subscribe_text_message": "text",
  "subscribe_text_message_updated_at": "2026-02-17T04:58:08.659Z",
  "unsubscribe_text_message": "text",
  "unsubscribe_text_message_updated_at": "2026-02-17T04:58:08.659Z",
  "credit_total": 1,
  "child_badge_printing": true,
  "child_sms_check_in_notifications": true,
  "child_email_check_in_notifications": true,
  "child_push_notification_check_in_notifications": true,
  "child_receive_feature": true,
  "child_mobile_app_check_in": true,
  "child_drop_off_time": 1,
  "child_cancel_check_in": 1,
  "child_kids_app_code": "text",
  "teenager_badge_printing": true,
  "teenager_sms_check_in_notifications": true,
  "teenager_email_check_in_notifications": true,
  "teenager_push_notification_check_in_notifications": true,
  "teenager_receive_feature": true,
  "teenager_mobile_app_check_in": true,
  "teenager_drop_off_time": 1,
  "teenager_cancel_check_in": 1,
  "teenager_kids_app_code": "text",
  "follow_up_reminder_time": 1,
  "allow_testimony_sharing": true,
  "allow_testimony_sharing_to_others": true,
  "contribution_statement_duration": 1,
  "contribution_update_window": 1,
  "allow_contribution_type_change": true,
  "contribution_notification_users": null,
  "contribution_minimum_amount": 1,
  "contribution_maximum_amount": 1,
  "cycle": "yearly",
  "android_app_url": "text",
  "ios_app_url": "text",
  "app_onboarding_screens": null,
  "app_name": "text",
  "has_app": true,
  "auto_deduct": true,
  "stripe_customer_id": "text",
  "quick_actions": null,
  "explore_modules": null,
  "external_links": null,
  "status": "active",
  "enable_give_module": true,
  "enable_unified_communications_module": true
}