PIpipeshub-ai
Knowledge Base

List all knowledge bases

Changed on

Retrieve a paginated list of all knowledge bases accessible to the authenticated user.

Overview:

Returns knowledge bases where the user has at least READER permission. Results include the user's role for each KB.

Filtering:

  • search: Full-text search on KB names (max 1000 chars). A longer value is answered 500, not 400.
  • permissions: Filter by user's role (comma-separated: OWNER, WRITER, READER)

Sorting Options:

  • name — Alphabetical by KB name
  • createdAtTimestamp — By creation date
  • updatedAtTimestamp — By last modification
  • userRole — By permission level

Performance:

Uses efficient pagination with limit/offset. For large result sets, use smaller page sizes.

Query parameters:

Only page, limit, search, permissions, sortBy, and sortOrder are allowed; any other query key is rejected with 400 (VALIDATION_ERROR: "These fields aren't accepted here: <key>."). A parameter sent more than once is rejected the same way. page, limit, search, permissions and sortBy sent with an empty value are read as not sent; an empty sortOrder is rejected.

get/knowledgeBase

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:read

Query parameters

pageinteger

Page number (1-indexed). Omitted or empty values default to 1. A page past the last one returns an empty list. The value is read with JavaScript parseInt, so text after leading digits is ignored (1abc is page 1); send a plain integer.

limitinteger

Results per page (max 100). Omitted or empty values default to 20. Read with JavaScript parseInt like page.

searchstring

Search KB names (max 1000 chars after trimming). Rejected with 400 if it contains HTML/script tags, event handlers or javascript: (HTTP_BAD_REQUEST), or a printf-style format specifier (VALIDATION_ERROR). The format-specifier check also catches ordinary text such as 50% discount (%, a space, then a letter like d). A value longer than 1000 characters is answered 500.

permissionsstring
Example:OWNER,WRITER

Comma-separated permission roles to filter by. Each token must be exactly one of OWNER, WRITER, READER: upper case, with no space around the commas. Empty tokens (OWNER,,WRITER,) are dropped, but a value with no role at all (,) is rejected. An empty value is read as not sent.

sortBy'name' | 'createdAtTimestamp' | 'updatedAtTimestamp' | 'userRole'

Field to sort by. An empty value is read as the default.

sortOrder'asc' | 'desc'

Sort direction.

Response

Successful operation

Changes

  • dbb5e203b445Revision changes
    • breaking

      added the pattern ^(?![\s\S]*?(?:%(?:\d{1,10}[!$]|[#0\-+ ]{0,10}\d{0,10}\.?\d{0,10}[diouxXeEfFgGaAcspn%]|\d{1,10}[a-zA-Z]))) to the query request parameter search

    • breaking

      added the pattern ^(OWNER|WRITER|READER)(,(OWNER|WRITER|READER))*$ to the query request parameter permissions

    • warning

      for the query request parameter page, the max was set to 90071992547409.00

    • info

      added the optional property // to the response with the status

  • bb0c59adf026Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status