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-bookmarks-in-the-list
title: "Get bookmarks in the list"
description: "Get bookmarks in the list"
sidebar_label: "Get bookmarks in the list"
hide_title: true
hide_table_of_contents: true
api: eJzNWN1v2zYQ/1cEvmwDhDgdOqzQW1psXfbRBGuKPQR+oMWTxZgiVfLkxDX0vw9HypLs0I7SBtie4oj3+bvj8e62TIDLraxRGs0y9h4wWRizqrhduUTqBEtIlHTIUoZ86Vh2y/6UDh2bp8xB3liJG5bdbtkCuAV70WDJstt5O09ZzS2vAME6T+DyEirOsi3DTQ0sYw6t1EuWMnjgVa3okwQp1MNmWd3fvfnZPHz5qXxANPkb0i7Rk5D2S8HalFn43EgLgmVoG0iZ5hURqECQMkkO1RxL1qYn1eumIr+4y1nq8SDnBBS8Uciy8GVPX8GVGxQ6Y/HKCrA7nZ8bsJu4Ut1UC7CnpClZSZwgqTd/B8y7xjpzUnQeKJ6WvTBGAddshEKAeD9ZLovEASZoEn/aJ853LsmNRtCY3EulkgUkUueqESB2KWXB1UY7OEs+GIQ0wVIOTDnXxKO4XUJSGJs4U8GQlmdRH/8npvVgd2LfBcYD0OfkQFDjCPcfz8/pz74PV4s7yMlOLP0VTARHTho6Y4iD17WSOSeO2Z0jtkg4jRfEUlZbU4NFGZT2Vo9IubV8Q8YiVO5pEVI8zsg2ZbkFjiAuMHpaGSELGT9OmW6U4gvKaIpc2+f3BEpu81KuQUQyuU1ZwdeGytWxc+TLpdTLj8ixcU/rG+qGa/IcnGOkQqrGAsEEWhDXvE2Za6qKW/nFR+nlxWuD0+AJdmym0ZrG5hPEjqpnLVnK7mFBCarod2UWUoGv7wjaUVKnzEm9VFCEA+vdklVtLHpfGgf2Mp5T4fV54UQNdzVywBF5XoJ4G4Wr95ncLJuKazZv94rSLWns5O9J83SjC2w0XBX+fTztQDg9boqSehUgtCqO3+RrtFeFJtDLii/hU0ztMeIL5wBjcY5lYm4BtCsNPoeraJS6Jk2hJDyHtbaQW36vQHwF81oKMM8ylK9lPhHoEiv1bkidJ+m7NHuOOTvPpyngDZbGTkO1WSjpSphGLTjCdccxzXDi+Kt7WCYwHFxWTx3uzpw6om+7iwgPoZz5H7HLGMrrtDsTN3Wn41tt5ZQc3lj/6+YJcn99SYkoBqYjFZuK/IdogT364EytIk5+GYvtuurjV+CrYR5AGXx9AdQbvdLmPvJqeIZ520P78k/epDDTa/LbqNqMy/AOiY/jLwuuNdjLLjsOqi/r6iLRdT2nr0ksUmxZaAI+1cpwAfSGDlg9K6Viz/Hg+7yNEgyN616bOmot9/rIw6Yx3uv1bU3XxAxZ2Qd5PoxxbzuEGBmo4QG7ue7ZHg/t/Z6ckaprvpSa/H3bk7Yel9fnrx+PIzR4J9pgUphGi5cbQ3Ij4j1YBc5RPj0+O/DUSxjoKbat58fSCJaxZUg12gRkbEajlJttw5qgnY1hcmDXu3WF76PYlgthwbl2xms5W7+iVOZWEure+O44oLVbGJSItctmM7SbsxW3fAVQn/G6ZodT6k0JSSchMYWfPv/o6JNgCwVktGn5SJh209to39IDRJr9ZSUyGm88Ed07/+NXYytOFv7+z41HUerCEDt5HUx6dXZ+dj7aKvT2XFxfRu2/uL70g/Ce8eQsPfrGITXH2XY3FZ/aLx30nX16nV5KBcfpOZzViks/ynU9cIj4rd8IUXizfjU0BH2estI4JLLtdsEdPUFtS5/DqE6pIKSjgA+7hhVsDvY+a64assPvU47Q7zY7U2j7Vc1p4qOQ/Yf7j2hEglePdiKDd/PhYsUxP+rq9393peCH5Jj23QOqN2OdQ1zCRpEemBI4BZQsCIcXeQ712NRHpY5M70vN+19uWOiLx0uG/Vs4nvb2TdpuA8WNWYFu295CpP/JwLb9F46ffEA=
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 bookmarks in the list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/lists/{listId}/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Get bookmarks in the 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":"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 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"]},"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"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
