Deals

List deal tabs

GET/deals/{dealId}/tabs
deals:readlist_deal_tabsRead-onlyDeprecatedSunset 2027-06-30

Lists the deal's built-in content tabs (each a key/enabled/type triple), ordered by the deal's stored tab order. ?include=custom appends the deal's custom tabs (each carrying its own uuid and content). Deprecated: it will be withdrawn on 2027-06-30. The tabs field of GET /deals/{id} replaces it, and GET /deals/{deal_id}/custom-tabs lists custom tabs; the Link header names the deal.

Path parameters

  • dealIdstring (uuid)Required#

    The deal's public uuid.

Query parameters

  • includestring#

    Set to custom to append the deal's custom tabs.

    One of: custom

Responses

200

OK

DealTab[]
{
  "data": [
    {
      "key": "video",
      "type": "content",
      "enabled": true
    },
    {
      "key": "team",
      "type": "content",
      "enabled": true
    },
    {
      "key": "location",
      "type": "content",
      "enabled": false
    }
  ]
}
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}/tabs\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"