aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-04-27 19:11:34 +0000
committerMohamed Bassem <me@mbassem.com>2025-04-27 19:11:34 +0000
commitf24d704571c83780e9373c6e2733e62073133dcf (patch)
tree7b090ad3452885e17a7639b907cf9cabe9e4aa81 /docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx
parentc81e7bae942291d8c7b39495ed8c4caf646c5992 (diff)
downloadkarakeep-f24d704571c83780e9373c6e2733e62073133dcf.tar.zst
docs: Release the 0.24.0 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx b/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx
new file mode 100644
index 00000000..da168ceb
--- /dev/null
+++ b/docs/versioned_docs/version-v0.24.0/API/get-a-bookmarks-in-a-list.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-a-bookmarks-in-a-list
+title: "Get a bookmarks in a list"
+description: "Get the bookmarks in a list"
+sidebar_label: "Get a bookmarks in a list"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNWEtv4zYQ/ivCXNoCQpwttujCNydoF+ljN2hS9BD4MBbHFtcUqSUpJ15D/30xlCzJDp0o3QDtKY44j2+enOEOBLnMytJLo2EK78knPqdkYcy6QLt2idQJJko6Dyl4XDmY3sEf0nkH8xQcZZWVfgvTux0sCC3ZWeVzmN7N63kKJVosyJN1gcBlORUI0x34bUkwBeet1CtIgR6wKBV/kiSFetiuivtP7342D19+yh+8N9k71i59IGHtVwLqFCx9rqQlAVNvK0pBY8EEqiFIQbJJJfoc6jSiXlfFguyhoCUqN5RUSL8X9Lkiu41L6gzZY7ysrDNPis4aiudlL4xRhBpSELTESvm9tYeRu1omjoNnknDaRfA7l2RGe9I+uZdKJQtKpM5UJUhwbDnYllxptKOz5IPxlCY+lz1Thpp5FNoVJUtjE2eKQX6cRW38n0DrnN2KvWwYj5w+ZwMaNY79/uP5Of85tOHj4hNljNPnoRoSgR5ZQwuGObAslcyQOSafHLNFwmmCIEihtKYk62WjtEM9IEVrcctgPRXueRFSPM7IOoXMEnoSMx89LYyQSxk/TkFXSuGCM5ojV3f5PYISbZbLDYlIJtcpLHFjuHOcOve4Wkm9uvHoK/e8vhRIVwW3JldlGTkHrEKqyhK7ibRgrnmdgjZ+HH5XFQXa7TivhL74ynFrUjdygN5jlpO4iILbOwIlpJBXBWqY1wc1escaW/kH0gLdIJ+Npo/L0LmfNqA5PQ1FSb0Ozq+silo0PqsOinIEvSxwRX/H1J4injlHfHuMypHMEmmXG/8SrmWl1DVrairkJaylpczivSLxL5g3UpB5EVDcyGyko3NfqMs+dZ6l35sxjhornxs7zkXVQkmX0zhqgZ6uW45xTmGOP9umOYLhqPICdVMIc77tv62wPD34UFjhR6yynKlsNrIA4lD3Or4VK3LiBbDh1+0z5KEWWYlY9kyxvOU8lYo+RLtlrGZf4JEUnPwyFNtOjLF8Hp37cTf3TultfQWvV3qtzX3kCggM87pz7evfX6PC3HfQvd03wy8L1JrsVZsLR40T2pbGdO30FLobRPok19wpV4TbsEc7r6ME/Rh1MDQNBp2DqeZ4hGmHhD5ROr/P+63hojUDGIGmB9+uES9Oqn6aPJAzUHWNK6nZoIuOtA6Gvz1/+3j65ZUr0cYnS1Np8XpTb2ZEfMYpyDkO+uOzI0uDhJ6eg1cHfp8bAVNYNfnAO+AUJjy5u8muWRDrydBNjuxmv6iGOQV2KIQl5+oJlnKyecP5hlay1wP49rjxVruZQe596aaTibfbszVaXBOVZ1iWcLwU3eaUtBISswzLzu8tfdJg4YAMduwb9mm7LAw27c5BrJntCGQ8TQciLo7w41djC2SEv/1zG7wo9dIwO1vdQHpzdn52PlhiOzyz66so/tn1Vdi7DsCzsXwPG+d5+Jzu9ksYvy3giZeFo7muS6/nHiQa0/mOmpQKZdgd2imzifldeA3gAE+7Z4E+7PMUcuM8k+12C3R8L9Q1f252Q04GIR2HvF9u17QdPA1sUFWMISzvJ2i7Xf9p4pNO+A8X6KiHG6seLdW9dfO+VOI+PGnq93+1xf1Dckr7/pbS26HOPi7N6xDfbDmh4EHwbtcezrKMyiHUR82LoXfN4/0vt9AMn8Mt9bCuhvvRIaTdrqG4NWvSdd0h9Pw/A6zrrx6euwY=
+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 a bookmarks in a list"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/lists/{listId}/bookmarks"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get the bookmarks in a list
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"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 list 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"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"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},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+ \ No newline at end of file