get-all-bookmarks.api.mdx•5.75 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: eJytV01v2zgQ/SvGnIU43aNubrHbZoHdBkgWewh0GEsji7VEquTQqdfQf18MJVtSyiRK21Mc8c0n3wxnTlCQy61qWRkNKXwkXmFdr7bG7Bu0ewcJMO4cpA/w/vItS8BR7q3iI6QPJ9gSWrIbzxWkD1mXJdCixYaYrAsAl1fUIKQn4GNLkMLWmJpQQ5eApa9eWSogLbF2lIDGRiBo80odqIAElLj21ZM9Qpf8mLYSD0YcXqRP+2ZL9iV1tWoUL9Dk2Cq9kyQqruXDB2+deVF13iPmujPBu9ZoR07U/3Z9LX/ml/d5+4VyXj0qruaXuCqQ8QoSyI1m0iyi2La1ylFE11+cyEfcN0EjJNBa05Jl1Vsf2TFC0Vo8itdMjXtdhSq+z1KXQG4JmYoNR08bU6hSxY8T0L6ucStZZuupu+R8AfLCtSinJtyJnjPudkrv7hjZu9ftJUDaN1JRzuc5OamxElXtLUmaSBcilXUJaMPL/He+adAel2UllPMvvreeu5EDZMa8ouJ91LlzIlBBApVvUEPWzWrjQSwO+mfaAm7CZ6PpcxmazcsB9KfPu1IrvQ/J97aORrScVbPqXIBXDe7on5jZ58Ab54hvIlcS40huibSrDL9FqvR1fSuW+gp5i2hrKbf4WFPxA8IHVZB5k6N4UPnCRFfc1B9G6ryKP4exDI2eK2OXpchva+UqWoYukOl2kFiWFJH4a2iaCwSeVF5A94WQyev2c4XF9I1DYYUfscpyxtt8YQHEXT3b+FlfUYgXnA2/7l+Bh1oUI0U5CsV4KzxVNf0d7Zaxmn1DRhJw6r+p2mGKifF5MffjaR6TMsb6C7Lu9V6bx8gTEASy7pLaX/9+LbrmsYOe476bftmi1mRvBi48aZwwtDTBDdNT6G4Q6ZNSc8+lIryGo7dZFwWMY9RsaEqmQ/VsIp6PMMOQMBLlkvdsnGTP6wCIB5q+8TDavplU011jomdi6hZ3SktA4wrSdSHyhrgyBaSw61OJsoLAeqrSkT2c95DwpsMJi8KSc90aW7U+vJO7QavEw8CR4bgfsEv0NUMKFXPr0vWa7fGqMmgLslfYtvDkmYf7ilaDgpUpV1zRaoCvek/E9ckCdScz9zBWT9aoSxLFrkQRYDJ3BpDQKPz4w9gGxb8//70PN6F0aURcYu49end1fXU9WUE+De5sbm+i3m9ub1alscH1M1YilffKOJYhLT2dt5XYwvhk7rl0m/h22YcpnXvd1qjCRD3MXv11ThmSJVAZx/LxdNqik97YdfK5X5Tkkgvl5CrHxWpPx/k+ecDai9Gwsz0Dn5XHEoHzSrgEe9nxRnA2kjAs0QlUhIVMBg+nQWqT59ROTXy3w4mWS0l8/P0e+mlkurbM6TMdmFEfJ7pPpx5xb/akuw7OrrP8D500nv8BF0eYEQ==
sidebar_class_name: "get api-method"
info_path: API/hoarder-api
custom_edit_url: null
hide_send_button: true
---
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"}]}
>
</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>