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: eJzNGMtu20bwV4i9tAUIyylSNODNCdrUfcRG46AHQ4cRORTXWu4yu0PZisB/L2aXIimZkunEQHuyzJ33e2YrMnSplRVJo0Ui3iNFC2NWJdiVi6SOqMBISUciFgRLJ5Jb8ad05MQ8Fg7T2kraiOR2KxYIFu1FTYVIbufNPBYVWCiR0DoP4NICSxDJVtCmQpEIR1bqpYgFPkBZKf4kUWbqYbMs7+/e/GwevvxUPBCZ9A1zl+RBmPtlJppYWPxcS4uZSMjWGAsNJQOoABALyQpVQIVo4pPsdV2yXuBSEXt7sHIZ5lArEkn4sscvB+V6hs5YurIZ2h3PzzXazThTXZcLtKeoKVlKmkCpE39nmHe1deYk6TRAPE17YYxC0GJghWDi/WC5zCOHFJGJ/GsXON+5KDWaUFN0L5WKFhhJnao6w2wXUhZdZbTDs+iDIYwjKmSPlIJmHAV2iVFubORMiX1Yno3q+D8RrTN2S/ZdQDww+pwVCGwc2/3H83P+s6/D1eIOU5aTCp+CUQYEzKEVhjGgqpRMgTFmd47RRtxpPCERi8qaCi3JwLSTegAK1sKGhSUs3dMkZPY4IptYpBaBMLug0dfSZDKX48+x0LVSsOCIZs81XXxPgASbFnKN2UgkN7HIYW24XB17J1gupV5+JKDaPc2vrxuuTlN0TjALqWqLbCbUGWPNm1i4uizByi/eSy9PXhuaZp4gx2YarKltOoHsoHpWUsTiHhccoIp/l2YhFfr6TqgdB3UsnNRLhXl4sF4tWVbGktcltJgXjsaQkCMPQARpgdnbUZt0irEuRV2CFvNmr/LcMseW/h41DzfIUqPxKvdN8LQC4fW4KErqlbdTbdWoRtNzZa/UTICXJSzx0xjbY8AXziE34knhllpE7QpDz8HKa6WumVPI++egVhZTC/cKs69AXssMzbMEhbVMJxq6oFK960PnSfg2zJ4jzk7zaQygpsLYaVatF0q6AqdBZ0B43WJME5wx/mq7xwSEg2T10CF35jz2fFsuEj60NYt/jCVjqKHTcmZc1B2Pb5UVODi8sP7XzRPgPn2ZSZb3SGOxxaEtFX4YLbBHu8rUKuLklyHZdnQ+ngJfbebeKL2uL2D1Wq+0uR/pGh5h3nSmffmWN8nN3E1+G1SbYRneWeLj8MsCtEZ72UbHQfUVbV1kuHaw9DVJjBRbzkKH9lOlDGTIPbS31bNCaqwd97rPm1GAfjrdm0UH8+PesHg4GY4PdO3s0gdj59t5v6K9bQ0jWC6ND9TubM9WtB/d9+gMWF3DUmpW820H2nhzvD5//XjV4KU60oai3NQ6e7kVIzXZ+OhVonMcRo/fDjT1FHp4dmnj8akwmUjEMkQYb/mJmPGa5GbbcAJoZkMzObTr3SnCj09iC1lm0blmBpWcrV9xBIOVbHUvfPscrLU7BhRElUtmM7KbsxVYWCFWZ1BV4nADvSkwailEJveb5R8tfBRkYYcMrigf2abtZja4pXQGYs4+RxmMVxcPxOnmf/xqbAks4e//3HgrSp0bRmetg0ivzs7PzgcXg06ei+vLUfkvri/9krsnPCvLvd444pk42e423lO3o4Nxswuv0wenoDh3wVmlQPo1rR19g8dv/bWH3Zt0Z5/e6fNYFMYRg223C3DceZqGP4c1nEMhk44d3t8RVrg5uOmsQdUsh7+VHIHfXW2mwHZnmNPAR032H942Rj0StHp07+i1m/eJNW7zo6p+/3dbCn6IjnHf9U29GfLs/RKuhdxXCgR2KEsQHi/SFKuhqI9KHYvelZr3v9yIMA4PDwj7WThc8vZF2m4DxI1ZoW6aTkLi/1nApvkXsx9wOw==
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"]},"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"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
