Deals

List the custom tabs of a deal

GET/deals/{deal_id}/custom-tabs
deals:readlist_deal_custom_tabsRead-only

Lists the deal's custom tabs, oldest first, each with its sanitised HTML body. A custom tab is an extra tab investors see on the deal, and its id is its key in the deal's tabs. An unknown deal returns 404 naming it. Use GET /deals/{id} to read the whole tab order.

Path parameters

  • deal_idstring (uuid)Required#

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

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.

  • fieldsstring#

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

  • sortstring#

    Comma-separated fields to sort by: created_at or updated_at. Prefix a field with - for descending. Defaults to created_at. The tab id is always the final tiebreak.

Responses

200

One page of the deal's custom tabs.

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"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"