v1

latestOpenAPI 3.1.02026-07-265094114.0 KB

Knowledge

Retrieve knowledge items

Returns a list of knowledge items available to your workspace, sorted from most recently created

get/v1/knowledge

Query parameters

qstring

Example:metadata[key]:value

You can use the q parameter to run a query parameter search. Query parameter search supports the following fields: name, tags, metadata, and settings.

Supported operators: AND

The AND operator can be used to combine multiple search criteria.

NOTE: The AND operator supports a maximum of 10 operators

Available field examples:

name: value

tags: value

metadata[key]:value

settings[appVisibility]:visible

metadata[key1]:value1 AND metadata[key2]:value2

pagenumber

Example:1

The desired page number of Knowledge items

sizenumber

Example:10

The number of Knowledge items per page to return in the response

Response

Retrieve knowledge items

requestIdstring

resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "knowledge",
  "data": [
    {
      "name": "Product Release Monthly Webinar - May 2023",
      "file": "jasperbrandvoice.pdf",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "id": "kno_2ee766eaa4ef48e59da1d9602bfecf2d",
      "createdAt": "2023-09-21T15:38:00.474Z",
      "updatedAt": "2023-09-21T15:38:00.474Z",
      "processingState": "InProgress",
      "tags": [
        "tag1",
        "tag2"
      ]
    }
  ],
  "pagination": {
    "totalRecords": 1,
    "page": 1,
    "size": 10
  }
}