Retrieve knowledge items

Returns Knowledge items available to your workspace, ordered by most recently updated. Pagination defaults to page=1 and size=10. Omitted controls default independently. The legacy limit parameter overrides size. There is no fixed page-size cap. Controls must be positive safe integers (at most 9007199254740991), and (page-1) times the effective size must also be a safe integer; otherwise HTTP 400. Zero, negative, fractional and nonnumeric page, size or limit values return HTTP 400, even if size is overridden by limit. A page beyond the last returns empty data with the matching totalRecords, requested page and effective pageSize. No matches returns totalRecords=0. Follow pagination.next and pagination.prev to preserve q. Each request reads current Knowledge: additions, updates and deletions can change totals and page membership, so navigation is not a snapshot and items may repeat or be skipped. Example: GET /v1/knowledge?q=name%3ABrand&page=1&size=10. Follow the returned pagination.next URL until it is null.

Query Params
string

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

number
1 to 9007199254740991
Defaults to 1

Positive integer page number. Defaults to 1 independently of size or limit.

number
1 to 9007199254740991
Defaults to 10

Positive integer items per page, with no fixed API cap (subject to safe-integer arithmetic). Defaults to 10; overridden by limit.

number
1 to 9007199254740991

Legacy alias for size. Takes precedence over size; positive integers only, with no fixed API cap (subject to safe-integer arithmetic).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json