Deals

List the visibility rules of a deal

GET/deals/{id}/visibility
deal-visibility:readread_deal_visibilityRead-only

Returns every rule that shows or hides the deal, each with id, entity, entity_id and included, ordered by entity and id. It is the superset of the classifications and exclusions sets. Rules about classifications that no longer exist are left out. An unknown deal, or one the token can't see, returns 404. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

200

Every visibility rule of the deal.

DealVisibility[]
{
  "data": [
    {
      "id": "string",
      "entity": "classification",
      "entity_id": "string",
      "included": 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/{id}/visibility\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"