get-a-single-bookmark.api.mdx•6.14 kB
---
id: get-a-single-bookmark
title: "Get a single bookmark"
description: "Get bookmark by its id"
sidebar_label: "Get a single bookmark"
hide_title: true
hide_table_of_contents: true
api: eJzNV0tvGzcQ/ivEXNoCC8spUjTQzQnawC2aGLWLHgwdRsuRltYuuSG5shVh/3sw3KdkKl4nBtqT5eUM55tvHpzZgySXWlV6ZTTM4T15sTRmU6DdiOVOKO+EkpCAx7WD+S28bQ8dLBJwlFZW+R3Mb/ewJLRkLyqfwfx2US8SKNFiQZ6sCwIuzahAmO/B70qCOThvlV5DAvSARZnzJ0VK5g+7dXF/9+ZX8/D5l+zBe5O+YQTKB5EOwaWEOgFLnyplScLc24oS0Fiw0HIQSkCxZyX6DOokAmNpTE6oIQFJK6xy3911SM3lSjjywhsRTnuafnAiNdqT9uJe5blYklA6zStJUigtfEbCkiuNdnQmPhhPifCZGpRS1KyTo12TWBkrnCmov92dHXq5wtz9f6D1fLfXvmsUO84/VWR3wKnQmXHM+8/n5/zn0IePyztKGafPhgyU6JGttIBYC8syVymy1uzOsWokpCZcBgmU1pRkvWoMK/k4++oEUkvoSV746GlhpFqp+HECuspzXHJiMvV1n6YTJNGmmdqSjKRincAKt4aL69S5x/Va6fW1R1+5p+0lQLoquIJdlabkHLAJlVeWmCbSkrUWdQLa+Gn4XVUUaHfTWAntoxdEa3HHWeKpcN8ctyb3IgfoPaYZybdRcB0RqCCBrCpQw6I+KLJbCD0v3H9wW5AbJaPR9HEVmtvXHWhOT0PJld4E8iubRz2anlUHVTVBXhW4pn9iZk8JXzhH/jISkliOpJZIu8z452itqjy/YktNhTxHtbSUWrzPSX6D8lZJMs8CiluVTiQ680X+bkidJ+U7N6ZJY+UzY6dRVC1z5TKaJi3R01WrMY0U1virbZoTFI4qL0g3hbDg5/r7CsvTgw+FFX7EKsuZyqYTCyAOtbPxvViREy+ADb9unhAPtchG5GpQiuUt56nK6UO0W8Zq9hmMJODU5/G1uiqWZKP5PDn34zQPpAy+vgDrld5ocx95AoLCou6pffn3a1KYhw7a+X09/rJErcletrlw1DihbWks145UobtBpE9yzZ2iIryGA9pFHRUYxqiDoWk06BxMNccjTDskDInS8754PPxDHTC8Pn/9eJLsZIQ2XqxMpeXLTZCpkfGRoyDnOAaPz46oCjcM8sxlHfR9ZiTMYd2Eh7eVOcz6WXu2H1aaGnj1sttusQpDA+xRSkvO1TMs1Wz7ioOPVnFdBejtccNXu+dA5n3p5rOZt7uzDVrcEJVnWJZwvGLcZCTaG4RZhdXhz1ZeNFg4JKOd8JoZbSyPN8OeHrbMfgQxHm2DEGdq+PG7sQUywj/+vQkcKr0yrM5eN5BenZ2fnY8Wwx7PxdVlFP/F1WXYYg7As7P8KBrneRKc77uVhldhFE7pdT7sPMf37ofE+sru3HjM78SszFGF+b2d9JpA3/b1yQUwH22viwQy4zyL7PdLdNyX65o/N8sVx18qx1E+sR2OIf6Hi2KUhA3tYsvjFvOKhcPq2CXxM1398e+26H4Sp6x3zVzvxjY7VKMghEcgI5Q8M93uW4GLNKVyDPdRY2H4fWG//+0GmjltvNAdZv14lTiEtd83EjdmQ7que5Se/2eAdf0FYTooOg==
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 a single bookmark"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/{bookmarkId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get bookmark by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"},{"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 bookmark data.","content":{"application/json":{"schema":{"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"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>