get-bookmarks-in-the-list.api.mdx•6.89 kB
---
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: eJzNWN9v4zYM/lcMvWwDjKY33LCD33qH7dD9uCt2HfZQ5IGxmFgXWfJJdNpc4P99oOzYTqqk7lZge2pqkeLHTyRFaick+typipQ1IhPvkZKFtesS3NonyiRUYKKVJ5EKgpUX2Z34TXnyYp4Kj3ntFG1FdrcTCwSH7qqmQmR382aeigoclEjofBDweYEliGwnaFuhyIQnp8xKpAIfoKw0f1KopH7Yrsr7z29+tA9ffygeiGz+hq0rCiJs/VqKJhUOv9TKoRQZuRpTYaBkAd0KpEKxQxVQIZr0rHlTl+wX+FykgQ92TuISak0ia78c2FuC9oNBbx19dBLd3uaXGt02btTU5QLdud20KhVN2KmHvyfmXe28Pbt13ko8vffCWo1gxIiFluLDYLleJh4pIZuE1T5wvvFJbg2hoeReaZ0sMFEm17VEuQ8ph76yxuNF8sESpgkValDKwbCOBrfCZGld4m2JQ1heRH38n0Drye62fdcqHpE+ZwdaM555//7ykv8c+vBx8RlzxklFSMFEAgFb6MCwBlSVVjmwxuyzZ7XIcdqwkUhF5WyFjlRrtEc9EgXnYMtgCUv/9BZKPo7IJhW5QyCUVxRdLa1USxVfToWptYYFRzSfXNPH9wRJcHmhNigjkdykYgkby+Xq1DrBaqXM6hMB1f5pe0Pd8HWeo/eCTShdO2Sa0EjWmjep8HVZglNfwym9/PbG0jR6WhzbaaSHWv/CYdFmRmQBiCAvUL6NguvrsxKpKOoSjJg3ByXgji12+x/sFuRG6WINflyG2+i8A+3qaShamXUgv3Y66tH0oD3I+QnyqoQV/hkze0r4ynvkG3FSjOQO0fjC0nO0lrXWN2ypTcDnqFYOcwf3GuU/UN4oifZZQGGj8olEF1Tqd0PoPCm/d2OaNNRUWDeNonqhlS9wmrQEwptOYxoprPF7V5MnKBxlXpBuE2HOzcS/SyzCBwqJFX7EMsvb2uUTEyAOdW/j32IFDrwANvy6fUI85CIbkctBKRa3HKdK44dotYzl7DMYSYVXX8fbdg1pLJ4nx36c5oGUwdcXYL02a2PvI1dAUJg3PbUvf39NOuahgu79/jT+sgBj0F13sXBUOEVX0liua85CdROROsk5d4qKcBsOaOdNVGDo0g56slEfddA0HXdI8camax2G8OlPYz6MKm875wTjMvhA3ezy7FAbWtiDfUambmClDLv5thdtAh2vL18/brl5uEyMpWRpayNfrtXOrYx3PiV6z6HweO3I07DDIM9H2gR9KqwUmVi1UcLTbiZmPC742a4dhZvZmCaPbrMfyUP3InYgpUPvmxlUarZ5xVEITjHrAXy33LK1H4oLospnsxm57cUaHKwRqwuoKnE8id0WmHQ7JHYZJqxfO/mkxcIHMnpN+MScdhPK6E2hJ4gtsx9BjFv4IMQpE378bF0JjPCXv24Di8osLauz1y2kVxeXF5ejybnHc3VzHcV/dXMdhr0D8Ows387WE7ek2W4/+Z17Qznq9vrwOv/w0jrO99as0qDCuNJ1nu2J34VXDz7erH/+GA59norCemKx3W4Bnu+KpuHP7TjKoSCV5wMf5uk1bo/eNjaga8YR3gxOyO9fL6bI9s8R54VPUvYfzvjRE2m9ejT3D97Nh8SKc37S1W//6ErBd8kp6/ubzmzHNodzaV/N+HYsEPhAGUG7eJXnWI2hPip1DL0vNe9/uhVtAzsepA+zcDxjHULa7VqJW7tG0zQ9QuL/GWDT/A0J8BsP
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},"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"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>