Documents

Get the deal's document directory

GET/deals/{dealId}/directory
documents:readget_deal_directoryRead-onlyDeprecatedSunset 2027-06-30

The deal's root document directory. With ?include=children the non-hidden direct children are embedded. An unknown deal or an unprovisioned tree returns 404. Deprecated: use GET /folders?filter[deal_id]={dealId} instead. It is withdrawn on 2027-06-30 and keeps its old response shape. Responses carry Deprecation, Sunset and a Link header with rel="successor-version" pointing at the replacement.

Path parameters

  • dealIdstring (uuid)Required#

    The deal uuid.

Query parameters

  • includestring#

    Set to children to embed the non-hidden direct children.

Responses

200

OK

DirectoryFolder
{
  "data": {
    "id": "071829a3-4b5c-4d6e-8f90-1a2b3c4d5e6f",
    "name": "Deal Room",
    "parent_id": null,
    "created_at": "2026-06-15T10:30:00+00:00",
    "children": [
      {
        "id": "1a2b3c4d-5e6f-4071-8293-a4b5c6d7e8f9",
        "name": "Due Diligence",
        "parent_id": "071829a3-4b5c-4d6e-8f90-1a2b3c4d5e6f",
        "created_at": "2026-06-15T11:05:00+00:00"
      },
      {
        "id": "2b3c4d5e-6f70-4819-9a2b-3c4d5e6f7081",
        "name": "Legal",
        "parent_id": "071829a3-4b5c-4d6e-8f90-1a2b3c4d5e6f",
        "created_at": "2026-06-15T11:07: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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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