List all notes.

GET /v3/enterprise/knowledge/notes

List all notes.

cURL

curl --request GET \
  --url https://api.devin.ai/v3/enterprise/knowledge/notes \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.devin.ai/v3/enterprise/knowledge/notes"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.devin.ai/v3/enterprise/knowledge/notes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devin.ai/v3/enterprise/knowledge/notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devin.ai/v3/enterprise/knowledge/notes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.devin.ai/v3/enterprise/knowledge/notes")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3/enterprise/knowledge/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "body": "<string>",
      "created_at": 123,
      "folder_id": "<string>",
      "folder_path": "<string>",
      "is_enabled": true,
      "macro": "<string>",
      "name": "<string>",
      "note_id": "<string>",
      "org_id": "<string>",
      "pinned_repo": "<string>",
      "trigger": "<string>",
      "updated_at": 123
    }
  ],
  "end_cursor": "<string>",
  "has_next_page": false,
  "total": 123
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

Permissions

Requires a service user with the ManageAccountKnowledge permission at the enterprise level.

Authorizations

Authorization · string · header · required

Service User credential (prefix: cog_)

Query Parameters

after · string | null

first · integer · default: 100

Required range: 1 <= x <= 200

access_type · enum<string> | null

Available options: org, enterprise

search · string | null

folder_path · string | null

pinned_repo · string | null

Response

200

application/json

Successful Response

items · KnowledgeNoteResponse · object[] · required

Show child attributes

end_cursor · string | null

Cursor to fetch the next page, or None if this is the last page.

has_next_page · boolean · default: false

Whether there are more items available after this page.

total · integer | null

Optional total count (can be omitted for performance).