Deals

List the investors a deal is shown to or hidden from

GET/deals/{dealId}/visibility/investors
deal-visibility:readlist_deal_visibility_investorsRead-only

Lists a page of the investors the deal's rules decide on, each allowed or denied, ordered by id. Classification and team rules are resolved to their members; a user rule beats a team rule, a team rule beats a classification rule, and within one kind a denying rule beats an allowing one. Investors no rule touches are not listed. It changes nothing. Use GET /deals/{id}/visibility for the rules themselves.

Path parameters

  • dealIdstring (uuid)Required#

    The deal's public uuid.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • filter[decision]string#

    Only investors with this decision: allowed (the deal is shown to them) or denied (it is hidden from them).

    One of: allowed, denied

Responses

200

One page of investors with their decision.

DealVisibilityInvestor[]
{
  "data": [
    {
      "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "decision": "allowed"
    },
    {
      "id": "9c4b1d2e-3f5a-4b6c-8d7e-0f1a2b3c4d5e",
      "decision": "denied"
    }
  ],
  "meta": {
    "limit": 25,
    "next_cursor": null,
    "prev_cursor": null
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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