Deals

List entities selectable for the visibility ACL

GET/deals/{dealId}/visibility/candidates
deal-visibility:readlist_deal_visibility_candidatesRead-onlyDeprecatedSunset 2027-06-30

Lists the classifications, teams and users the deal's existing rules already name, grouped by entity type; it does not list everything that could be selected. It changes nothing. Deprecated: it will be withdrawn on 2027-06-30; it has no replacement, use GET /deals/{id}/visibility, GET /deals/{id}/classifications and GET /deals/{dealId}/visibility/investors.

Path parameters

  • dealIdstring (uuid)Required#

    The deal's public uuid.

Responses

200

OK

DealVisibilityCandidates
{
  "data": {
    "classification": [
      "5",
      "12"
    ],
    "team": [],
    "user": [
      "9c4b1d2e-3f5a-4b6c-8d7e-0f1a2b3c4d5e"
    ]
  },
  "meta": {
    "source": "deal-acl",
    "catalogues": {
      "classification": "GET /v2/classifications",
      "user": "GET /v2/investors",
      "team": "GET /v2/groups"
    }
  }
}
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/{dealId}/visibility/candidates\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"