Documents

Search documents

GET/documents/search
documents:readsearch_documentsRead-onlyDeprecatedSunset 2027-06-30

Searches documents, matching q on name and description. Filter with fileType, folderId and ownerId (a user uuid); sort takes created_at, name or file_size, - reverses. Cursor-paginated; unreadable documents and, as before, documents in hidden folders are left out (the successor lists them). Deprecated: use GET /documents?filter[q]= with filter[mime_type], filter[folder_id], filter[owner_id] and sort. Withdrawn on 2027-06-30. Responses carry Deprecation, Sunset and a successor Link.

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.

  • qstring#

    Free-text query matched against name and description.

  • fileTypestring#

    Exact mime type to filter by.

  • folderIdstring (uuid)#

    Restrict to this folder uuid.

  • ownerIdinteger#

    Restrict to this user id.

  • sortstring#

    Sort column; prefix with - for descending.

Responses

200

OK

{
  "data": [
    {
      "id": "5e6f7081-92a3-4b4c-9d6e-7f8091a2b3c4",
      "name": "term-sheet.pdf",
      "folder_id": "071829a3-4b5c-4d6e-8f90-1a2b3c4d5e6f",
      "size": 482113,
      "mime_type": "application/pdf",
      "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
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/documents/search\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"