Transaction Workflows

List TM directories for the deal

GET/deals/{dealId}/transaction-workflow/directories
transaction-workflows:readlist_deal_directoriesRead-onlyDeprecatedSunset 2027-06-30

The transaction-management directory bindings for the deal, each linking a workflow step to a folder. Cursor-paginated. 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's public uuid.

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.

Responses

200

OK

{
  "data": [
    {
      "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
      "deal_id": "9f8e7d6c-5b4a-4938-8271-6a5b4c3d2e1f",
      "workflow_id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
      "workflow_step_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
      "directory_id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
      "created_at": "2026-06-15T10:30:00+00:00"
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": "https://your-org-domain/kong/core/api/v2/users?cursor=eyJpZCI6MjUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"
  },
  "meta": {
    "path": "https://your-org-domain/kong/core/api/v2/users",
    "per_page": 25,
    "next_cursor": "eyJpZCI6MjUsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
    "prev_cursor": null
  }
}
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

Request validation failed (HTTP 422). The body is either the Laravel validation envelope (message + field-keyed errors) or the API error envelope for domain rejections (e.g. form_type_not_supported, folder_locked, parent_not_found, folder_not_empty).

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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