1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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: eJzNGMtu20bwV4i59EJYTo+6OUGbukUTA3HQg6HDiByKGy13md2hHEXgvxezpEjKXttUYqA9idqd92tn5gA5+cypmpU1sIT3xAlqnayt3Vboth5SYNx4WN7B2+FslYKnrHGK97C8O8Ca0JG7ariE5d2qXaVQo8OKmJwPAD4rqUJYHoD3NcES1tZqQgNtCo6+NspRDssCtacUDFYCgi4r1Y5ySEGJaF8bcnto0x+jVuDOisCz6Hl2ymwgBTJNJaqjzyANphLdcyqw0QzL7uQZrt46/uhycjOYmqZak3uOmlaV4nPEZ8VaDt41zttnSWcdxHxTT6zArqH0QRxdF4knTtgm4XaIp198klnDZDi5VxJnlCiT6SanPFEm4ZISR762xtNF8sEypQmXakTK0AiORrehpLAu8baiMVovojr+T0QbjN2TfdchPjD6ShTo2Hix+6+Xl/JzqsPH9RfKRE4uT9M1yZFRWPVSCSrWtVYZCuriixf8iF9toAgp1M7W5Fh13Mc6MIKic7gXqZkq/zIJlT8OzTaFzBEy5Vccva1srgoVv07BNFrjWkJbXNgOgT4Dcqgq0eoxqRLRe8bNRpnNJ0Zu/Mv8xgLimywjL9W0QKUbR2ImMrlgrdoUfFNV6NT34KXXJ28szzNPJ8d+HqxtXDaD7KSM1gpSuKe1BKiW78qulRZp6RuT8RLdKXhlNpqK7sIFtVRVW8dBl+45euVo7DIzcoHMmJWUv43aZFBMdCmbCg2s2pMSdCcce/on1ALcJEutoY9FeCyfV6C7fVoUrcw22KlxOqrR/Fw5qTkz4FWFG/ocY/sU8JX3xNcRl8TCLXNExpeWz8EqGq1vhFOX9+eg1o4yh/ea8h9A3qmc7FmC4k5lMw1dcqXfjaHzInwfZueIc9R8HgNsuLRunlWbtVa+pHnQOTLd9BjzBBeMv/vXYwbCg2QN0F3urKT/+blcZPrW1yz5iCVjV0Pn5Uxc1COPn5UVJTiCsOHr9gXwkL7CJC9GpFhsSWgrTR+iBfbJV2VuFfHq+5Rs30M/nQI/bObRKKOur2D1xmyNvY+8GgFh1Q6mff0nb5ab5TX5Y1JtpmX4aIlP05M1GkPuuo+OB9UX+roocH1jGWoSRIqtZKEn97nWFvMwtY22OiukYs/xqPuqjQKM3elJL5pOp9KTkfK0M4w3dH3vMgbj4NvVOKsdp2wQuQx94354O1vR6Qg/oTNhdYMbZUTNcbJv22CPiri0OSxh0zkHZbKHxZSkJ7c7jveh1YAD5rkj79sF1mqxeyPeRqdEwhCH/XU3zRwn6JK59svFgt3+YosOt0T1BdY1PBzbbktKegqJLcI49lcPn3SyiPCTzcQnGXH6KWaynxjMKJxDPAuYtPkBSEIzfPxuXYUi4Z//3AZfKFNYQRetO5HeXFxeXE7G7EGeq5vrqPxXN9dhMjwRXpSVd9F6lv5xeTiOibFdzIOWbKhq8cVNp6i8EItaowojTN8Wdi6dRskqhdJ6lsPDYY1eanDbynE3mYqjc+XFneNovaX96apmh7oRpmF78AT4SeLMQZiuUebAHxclc2CHzcfzwE8a/j9cJ0T922n1aMUwarca0zJs61IoCcW24uAO+yrLqJ5iPVohCJWhSLz/7Ra6HnA6NZ+m03SyQbOf0D4cOohbuyXTtnBUgeU/tFKg/wWnsCCK
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"]},"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","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
</StatusCodes>
|
