get-all-bookmarks.api.mdx•6.6 kB
---
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/ivEXHohJKdH3RSjTdyisQG76MHQYUSOxI3IXWZ3KEcR+N+LWVIkJa9syjHQnixz5/3a+XYPKbnEqpKV0TCDT8QR5nm0NGZToN04iIFx7WD2CB+7b4sYHCWVVbyD2eMeloSW7LziDGaPi3oRQ4kWC2KyzhO4JKMCYbYH3pUEM1gakxNqqGOw9K1SllKYrTB3FIPGQkjQJpnaUgoxKDHtW0V2B3X8Nmkr3BoxeJQ8x1bpNcRAuirEdXQJxD5U4ntKK6xyhlnz5QWtzli+tSnZEUp1VSzJviQtV4XiS8xnxbl8uK6sMy+KThqK8aEeRIFtRfFJHd2sIkccsYn8aVdPv7goMZpJc/SkpM4oUjrJq5TSSOmIM4osudJoR5Poi2GKI85Uz5SgFp4c7ZqilbGRMwX11ToJ+vg/Ma0Ldiv2umE8CfpCHGjUOIn7r1dX8ufYh9vlV0rETs6O2zVKkVFUtVYJK5ZlrhIU1ulXJ/yBvBovEWIorSnJsmq093OgJ0VrcSdWMxXudREqfV6adQyJJWRK5xw8LUyqVip8HIOu8hyXUtqSwror9BGU3VQJTo/BlAieM67XSq/vGblyr+vrB4irkoScTNMVqryyJGEinQrXoo7BVUWBVv3wWXp/8drwuPA0duzGBd3fC+9cFk2LBA6QGZOM0o9B47pBrSCGrCpQw6I+mgWPorGVfyTN0w3axWi6Xflb62UHmtPzpuRKb3zwK5sHPRpftEfNP4JeFbimv0NqzxHPnSO+CaQkVCOJJdIuM3wJ16rK8zvR1DTgJaylpcTiU07pG5i3KiVzkaG4VcnIQGdc5Nd96bxK35bZJeYcPB+nACvOjB0X1WqZK5fROOoUme5ajnGGC8df7RgfwXDSrJ666Z2FLCI/14tM39n3ov8RakZnKpuM7JmwqQcdP2srSnF4Y/2vh1fIffuKknTVM4VqS0pb5fQlOGBDbX5BRGJw6sdQbLvMnm+BN4e5D0rv6ztEvdIbbZ4Ct4ZnWNRdaN//yhuVZrlNPg+mzXAMHyJxP/yyRK3J3rTVcTJ9oZ2LQtdueH4mQWDYSheeC46/Unv7F3WQoF/1jha7eAjxjvDZ8ZoV3o7a/aMvqC4/ix74HCAriF2avnOLhC4uviEeHsgZqLrDtdLiZg+T69rHoyDOTAozWDcBRoHJMB2KdGS3B6zs1wXYY5pacq6eYqmm2w+SMbRKLPS11B430OAARzPm0s2mU7a7yQYtbojKCZYlnGKgh4yiVkJkVh7b/NnSR40tYvwA5t8LXmghwQDsd2EUzb4mhUx2Zk8k5eV//G5sgWLhH/88+FwovTLCLl43Jn2YXE2uBpi1s2d+dxO0f35342HWkfHirNxtxrHsgLP9AXOFHjZO1qpuMoVfQRpHZcpPyxyVxwPtatekdFglixgy41g+7vdLdDJH61o+NzBPEp0qJ+nsceqGdsfvHlvMK1HqofgZ8qPGGcMwfJMYQ394dRhD2z0jvEx8NvD/ITYP5rfx6hle771b9G3pn75iyAgltpLghnueJFQOuZ7hcZHSDYlPvz1As8cNIehxOw3RCerdQPZ+31A8mA3puoaDCyz/Qy0D+l+/2OP7
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},"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","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>