get-all-bookmarks.api.mdx•6.23 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: eJzNWEtv3DYQ/ivCXHoRdp0eddsEbeAUTQzYRQ+GDrPSaMUsRSoktc52of9eDKXVY03bcmKgPVkm5/3ifHuCnGxmRO2EVpDAR3IRShlttd5XaPYWYnC4s5Dcw/vhLI3BUtYY4Y6Q3J9gS2jIbBpXQnKftmkMNRqsyJGxnsBmJVUIyQncsSZIYKu1JFTQxmDoWyMM5ZAUKC3FoLBiEjRZKQ6UQwyCTfvWkDlCG/+YtAIPmg1eJE811ZbMc+KkqIRbIMk6I9SOgyic5IMPjbH6WdFZR7Hc6xhyKrCRDhJnGoovUnpdRJZc5HTkb4fU/mKjTCtHykUPglNOkVCZbHLKI6EiV1JkyNZaWVpFn7WjOHKlGJkyVMwj0ewoKrSJrK5oLJxV0Mf/iWlDsHuxHzrGi6Cn7ECnxnLcf7264j9zH75sv1LGdrpy3jlRjg5ZVW8Vs2JdS5Ehs66/WuYP5FV7iRBDbXRNxolO+9iSIykag0e22lFlXxYh8sel2caQGUJH+cYFbyudi0KEr2NQjZS45dLmFLZDoS+gHBo82MiThg3eO9zthNrdOnSNfVlfDKSaiseYbbKMLA+2AoVsDHGYSOXMlbYxKO2W2W+bqkJzXBYVP0PfOG9dDQcu0DnMSsrfB407BwIFxFA2FSpI21mz3rPGXv5Mmqeb1LNW9KXwE/55B7rbp02RQu198Bsjgx4tr6pZdy6gFxXu6K+Q2qeIN9aSuw6kJFQjmSFSttTuNVxFI+UNa+o65DWstaHM4IOk/AeYDyIn/SpD8SCyhYEuXSU/jKXzIv3ZjWXU2LhSm2UharZS2JKWUefo6KbnWBYU5vizH5oLGC46z1N3jZDys/9zjeXou/ON5T9CnWV1Y7KFDRA29azjZ21FLjxvrP+6e4Hc9yIryYuRKVS3XKdC0ufgtAz17CsiEoMV/0zF9qtjqJ4X1344zGNQRl/fIOqN2iv9EHgCPEPaDqF9+/drUZrHCXr2+3Z6skWlyFz3tXAxOKEfaUzXb09+ukFgTnLPPRUK/xqO1qZtkGBco2ZLUzxFMjMYMl9h+iVhLJQh7ukIH84YDNgCRd9djydeXVRTgDeRM1F1gzuh2KER97Wt97wiV+ocEth1oUTGfbCeirRkDmfw5990OGGeG7K2XWMt1od3nBs0gi30NdJfdwt2D2egdK62yXrtzHG1R4N7onqFdQ2XSOKupKiXEOnCI4Q/evqos4WNn+DWW966+8V6gl6HMLJm9sOT8ebpibiQ/Mfv2lTIFn76+87nQqhCMzt73Zn0bnW1upogv8Gezc110P7NzbUHKzPj2Vl+s7R1vKglpzNyCSH1i91nmDhhWN85ytN7XUsUfqvu968updMqSWMotXV8eDpt0fJ8bFs+7sASJzoXltM5or09HedA/oCyYaUe0D5BPmuRJQxnLL6EdgDXzxM/Gcj/ELEG89V59QjFjt6lY5v532ZiKAlz3n3uTz33JsuonnI9QqksZWj6j7/dQbdvTYHZvD2mkADVcSL7dOoo7vSeVNvC2QXH/0PLo/VfqoVqsg==
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":"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"]},"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","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
</StatusCodes>