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: eJzNWEtv20YQ/ivEXHohJKdH3RSjDdyisQG76MHQYUSOxI3IXWZ3KEcR+N+LWVJ8yGubSgy0J8vceb92vj1CSi6xqmRlNCzgE3GEeR6tjdkVaHcOYmDcOlg8wsfu2yoGR0llFR9g8XiENaElu6w4g8Xjql7FUKLFgpis8wQuyahAWByBDyXBAtbG5IQa6hgsfa2UpRQWG8wdxaCxEBK0Sab2lEIMSkz7WpE9QB3/mLQN7o0YPEmeY6v0FmIgXRXiOroEYh8q8T2lDVY5w6L58opWZyzf2pTsBKW6KtZkX5OWq0LxJeaz4lw+XFfWmVdFJw3F9FAPosC2ovisjm42kSOO2ET+tKunX1yUGM2kOXpSUmcUKZ3kVUpppHTEGUWWXGm0o1n02TDFEWeqZ0pQC0+OdkvRxtjImYL6ap0FffyfmNYFuxV73TCeBX0lDjRqnMT916sr+TP24Xb9hRKxk7Nxu0YpMoqq1iphxbLMVYLCOv/ihD+QV+MlQgylNSVZVo32fg70pGgtHsRqpsK9LUKlz0uzjiGxhEzpkoOnhUnVRoWPY9BVnuNaSltSWHeFPoGymyrB6TGYEsFzxu1W6e09I1fubX39AHFVkpCTabpBlVeWJEykU+Fa1TG4qijQqu8+S+8vXhueFp7GjsO0oPt74Z3LommRwAEyY5JR+jFoXDeoFcSQVQVqWNWjWfAoGlv5I2mebtAuRtPtxt9arzvQnL5sSq70zge/snnQo+lFO2r+CfSqwC39HVL7EvHSOeKbQEpCNZJYIu0yw5dwbao8vxNNTQNewlpaSiw+5ZT+APNepWQuMhT3KpkY6IyL/LovnTfpT25Mo8aKM2Onhaha58plNI06Raa7lmNaUITjr3YmT2A46zxP3TTCSraKn2sspm/sG8v/CHWWM5VNJjZA2NSTjp+1FaXwvLH+18Mb5L4XRUm66ZlCdSt1qnL6HJyWoZ69ICIxOPV9KLbdTEP1PLn2w2Hug9L7+g5Rr/ROm6fAFeAZVnUX2ve/vyaluZ+gJ7/vh1/WqDXZm7YWzgYntCNN6NrlzE83CMxJ6bmXQuFvw97aVR0k6Le00U4WD9HZCFqNN6TwYtOuDn35dNlY9ZjlhDZB7NL0jVsQc3GpDaHsQM5A1R1ulRY3e4Rb1z4eBXFmUljAtgkwCsKF+VCkI7s/wVx/08MR09SSc/UcSzXff5CMoVVioa+c9rjZ6k9IMmMu3WI+Z3uY7dDijqicYVnCOXx5yChqJURm42HJny191Ngixg8Q+r2s+u02P8DpXRhFs/jhyWTd9URSXv7H78YWKBb+8c+Dz4XSGyPs4nVj0ofZ1exqADc7e5Z3N0H7l3c3HiGNjBdn5SYzjmV9WxxPcCn0JnG2EXVzKPyA0TgqM31e5qj8Kt9uZU1Kh1WyiiEzjuXj8bhGJ1OzruVzg9Ak0alyks4eYu7oMH6y2GNeiVKPol8gHzXOFIbhc8IU+tODwRTa7gXgdeIXA/8fwupgfhuvnkHt3rtV35b+1SqGjFBiKwluuJdJQuWQ6xmUFindkPj02wM0W9sQPY7baQgsUB8Gso/HhuLB7EjXNZxcYPkfahnQ/wKNWctP
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},"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","summarizationStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
</StatusCodes>
|
