List Knowledge Base entries within a project

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/knowledge-bases

Retrieves a list of all Knowledge Base entries for a specific project. The Knowledge Base stores proven or disproven hypotheses and their outcomes, serving as a repository of experimental learnings. Supports filtering by status, name, and pagination. The Knowledge Base article "Observations Feature Guide" explains: "Knowledge Base - Convert proven hypotheses to serve as a historical record and knowledge resource."

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

Body Params

onlyCount

boolean

If set to true in a list request, the response will only contain the total count of matching items (extra.pagination.items_count) and will not include the actual item data. Useful for quickly getting totals without fetching full datasets.

results_per_page

integer | null

0 to 50

Defaults to 30

Specifies the maximum number of items to return in a single page of results. Used for pagination. Default is 30, maximum is 50.

sort_direction

string | null

enum

Defaults to desc

The direction for sorting the list results, based on the sort_by field.

asc: Ascending order (e.g., A-Z, 1-10, oldest to newest).
desc: Descending order (e.g., Z-A, 10-1, newest to oldest). Defaults to desc (newest/highest first) if not specified.

Allowed:

sort_by

string | null

enum

Defaults to name

A value to sort knowledge bases by specific field(s)

Defaults to name if not provided

Allowed:

string | null

A search string that would be used to search against knowledge bases name

status

array of objects | null

The status of the knowledge bases you'd like to be returned; one of the below can be provided

status

200A list of Knowledge Base entries within a project. Each entry represents a learning or outcome from a tested hypothesis, including its name, summary, status, and creator.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.