Get the deal's settings

GET/deals/{deal_id}/settings

Returns the deal's own settings in three groups: communication (what investors can do on the deal), secondaries and entrepreneur. Settings belong to the deal, not to the acting user. A setting that was never stored shows its default: every communication switch is on, every secondaries and entrepreneur switch is off. entrepreneur is read-only and is null unless an entrepreneur created the deal. An unknown deal, or one the token can't see, returns 404.

Path parameters

deal_idstring (uuid)Required#
The deal's id, a uuid. An unknown deal, or one the token can't see, returns 404.

Responses

200

The deal settings.

DealSettings

{
  "data": {
    "deal_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "communication": {
      "enable_due_diligence": true,
      "enable_enquiries": true,
      "enable_meet_management": true,
      "enable_q_and_a": true
    },
    "secondaries": {
      "enable_secondary_investments": true,
      "show_outside_availability_window": true
    },
    "entrepreneur": {
      "enable_delegate_deal_entrepreneur": true,
      "enable_delegate_all_investors_deal_entrepreneur": true,
      "enable_analytics_entrepreneur": true,
      "enable_bookbuilding_entrepreneur": true,
      "enable_deal_status_entrepreneur": true,
      "enable_documents_entrepreneur": true,
      "enable_due_diligence_entrepreneur": true,
      "enable_enquiries_entrepreneur": true,
      "enable_key_contacts_entrepreneur": true,
      "enable_meet_management_entrepreneur": true,
      "enable_per_deal_settings_entrepreneur": true,
      "enable_q_and_a_entrepreneur": true,
      "enable_transaction_manangement_entrepreneur": true
    }
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

404

Resource not found (error.code = not_found).

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/deals/{deal_id}/settings\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"