aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-11-29 18:31:05 +0000
committerMohamed Bassem <me@mbassem.com>2025-11-29 18:32:19 +0000
commit97c386a4d15294b4ed07ff83c8a6a773e7289ab8 (patch)
tree3c8a22fdd92efa489638d5216714497d61b47b3e /docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx
parentf01d96fd91f8829d4d91c465e9950e78fc6f7513 (diff)
downloadkarakeep-97c386a4d15294b4ed07ff83c8a6a773e7289ab8.tar.zst
release(docs): release the 0.29 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx b/docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx
new file mode 100644
index 00000000..30d92a96
--- /dev/null
+++ b/docs/versioned_docs/version-v0.29.0/api/get-all-bookmarks.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-all-bookmarks
+title: "Get all bookmarks"
+description: "Get all bookmarks"
+sidebar_label: "Get all bookmarks"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNGMtu4zbwV4S59CLE2R59yy7abVp0EyBZ9BD4MJZGFtcUqSUpJ15D/14MKUuyQydyNkB7skzO+8WZ2UFONjOidkIrmMNncglKmSy1Xldo1hZScLiyMH+Aj/3ZIgVLWWOE28L8YQdLQkPmqnElzB8W7SKFGg1W5MhYD2CzkiqE+Q7ctiaYw1JrSaigTcHQ90YYymFeoLSUgsKKQdBkpdhQDikIFu17Q2YLbfo2agVuNAs8iZ51RqgVpECqqVh1tBmk3lSse04FNtLBPJy8wNVq425MTmYCU9VUSzIvUZOiEu4c8Z1wkg8+NcbqF0lnAWK6qUdWcKah9CiOrovEkkucTvxtH0+/2CTTypFyyaPgOKNEqEw2OeWJUIkrKTFka60sXSRftKM0caUYkDJUjCPRrCgptEmsrmiI1ouojv8T0Xpjd2Q/BcQjoy9YgcDGst1/vbzkn0MdbpbfKGM5XXmYrkmODplVJxWjYl1LkSGjzr5Zxo/4VXuKkEJtdE3GicB9qAMDKBqDW5baUWVfJyHy56HZppAZQkf5lYveVjoXhYhfp6AaKXHJoc0ubPtAnwDZV5Vo9RhViei9w9VKqNWdQ9fY1/kNBcQ2WUaWq2mBQjaG2EykcsZatCnYpqrQiB/eS+9PXmk3zTxBju00WN2YbALZURmtBaTwSEsOUMnflV4KydLSkyNlObpTsEKtJBXhwni1RFVr47wujSVzHY+p8FK9c6CGpI1coHOYlZR/jJqr15nVLJsKFSzag+r0wBw7+gfUPNwogbWim8K/oy8rEG5PiyKFWgcTGhm33+Q0OihHE+BFhSv6GmN7CvjKWnIxP8ciMTNEypbanYNVNFLeMqdQEs5BrQ1lBh8l5W9A3oic9FmC4kZkEw1dukp+GkLnVfguzM4RZ6/5NAbYuFKbaVZtllLYkqZB5+jotsOYJjhj/N09LBMQjpLVQ4fcWXBr9HO56OgplDP/EUvGUF6n5Uxc1D2Pn5UVOTi8sP7r/hVwn77MJC8GpBMVm4v8l2iBPfngTK0iVvwYk+3a69Mp8GYzD0YZdH0HqzdqrfRj5NXwCIu2N+37P3mT3MyvyR+jajMuw3tL3I1PlqgUmesuOo6qL3R1keG6ntPXJIgUWwhNwNdaasz9QDfY6qyQij3Hg+6LNgowNK4HbWo6HlgPps3DpjHe6/VtTdfEDFHZO3kxzHP7SRxYQEVPrhvwztZ4POaP6IxY3eJKKNZ3mP7b1humIlfqHOawCl5Cnv5hNiZpyWz2KwDfc8AO89yQte0MazHbfGC3oxEsoQ/I7jpMPPspu3SutvPZzJntxRoNronqC6xrOB7t7ktKOgqJLvzI9lcHnwRZWPjR9uKOx6Bu0hntMHozMmcf2AzGo4AH4hj1H79rUyFL+Oc/994XQhWa0VnrINKHi8uLy9Eo3stzdXsdlf/q9tpPjwfCs7L8QGrruJGc7/ajZGxfc9Sb9eUtvtwJivJTMaslCj/mdP1hcOk4ShYplNo6Ptztlmi5GLctH4fplR2dC8vuHMbvNW0P1zkblA0z9RuGE+AHGTQFYbxqmQK/X6ZMge23Iy8DnzT8f7hyiPo3aPVsDTFotxjS0m/0UigJ2bbs4IB9lWVUj7GerRmYSl8kPv92D6EZHE/Wh+k0HnFQbUe0d7sAca/XpNoW9io4/g8tV+p/AcIULI8=
+sidebar_class_name: "get api-method"
+info_path: api/karakeep-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+
+<Heading
+ as={"h1"}
+ className={"openapi__heading"}
+ children={"Get all bookmarks"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/bookmarks"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get all bookmarks
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"boolean"},"required":false,"name":"archived","in":"query"},{"schema":{"type":"boolean"},"required":false,"name":"favourited","in":"query"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"required":false,"name":"sortOrder","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"Object with all bookmarks data.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"userId":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
+>
+
+</StatusCodes>
+
+
+ \ No newline at end of file