Deals

Get a custom tab of a deal

GET/deals/{deal_id}/custom-tabs/{id}
deals:readget_deal_custom_tabRead-only

Returns one custom tab of the deal. An unknown deal, or a tab that belongs to another deal, returns 404. Use GET /deals/{deal_id}/custom-tabs to list them.

Path parameters

  • deal_idstring (uuid)Required#

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

  • idstring (uuid)Required#

    The custom tab's id.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The custom tab.

DealCustomTab
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "title": "string",
    "body": "string",
    "description": "string",
    "show_read_more": true,
    "show_reading_time": true,
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
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/{deal_id}/custom-tabs/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"