Documents

Deals associated to a folder

GET/folders/{folderId}/deals
documents:readlist_folder_dealsRead-only

The deals reached through a folder's association - read directly off the folder or inherited through its non-hidden ancestor chain. The folder may be hidden; it answers 404 when the token cannot read it. Unknown association ids are dropped (leak-safe).

Path parameters

  • folderIdstring (uuid)Required#

    The folder's public uuid.

Responses

200

OK

FolderDeal[]
{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "name": "Series B — Acme Robotics"
    }
  ]
}
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/folders/{folderId}/deals\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"