get-a-single-bookmark.api.mdx•6.36 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: eJzNV01v4zYQ/SvEXNoCQpwttujCN++i3aZFd4MmRQ+GD2NxbDGWSC1JOfEK+u/FUJ92lETJBmhPccQZzuPjm+FMCZJcbFXuldEwh4/kxdqYXYZ2J9YHobwTSkIEHrcO5kt43yw6WEXgKC6s8geYL0tYE1qyi8InMF+uqlUEOVrMyJN1wcDFCWUI8xL8ISeYg/NW6S1EQHeY5Sl/UqRkenfYZrc37342d19/Su68N/E7RqB8MGkRXEioIrD0pVCWJMy9LSgCjRkbrXujCBSfLEefQBWNwFgbkxJqiEDSBovUt3sdU3OxEY688EaE1Y6m75yIjfakvbhVaSrWJJSO00KSFEoLn5Cw5HKjHZ2JT8ZTJHyieqcYNfukaLckNsYKZzLqdndnx6fcYOr+P9A6vpttP9SOLedfCrIHYCm0YRzz/uP5Of85PsPn9Q3FjNMnvQIleuQoDSD2wjxPVYzsNbtx7DpypSZsBhHk1uRkvaoDK3lffVUEsSX0JBd+dDUzUm3U+HIEukhTXLMwmfqqk+kES7RxovYkR6RYRbDBveHkemjd43ar9PbKoy/c0/EiIF1knMGuiGNyDjiESgtLTBNpyV6rKgJXZBla9TVQ/Prba+On0VPjOEwjPVSnzhCtxQOL0FPmXiyLWtojC+g9xgnJ96PgWiJQQQRJkaGGVXWUw0sIJTXsf7RbsBto3Wj6vAm18/ED1KsPQ0mV3gXyC5uOnmi6aI+SdoK9ynBLf4+Ffch44Rz5i5ErGdNIbIm0S4x/jtemSNNLjlQn4HNcc0uxxduU5Auc90qSeRZQ3Kt4ItGJz9IPvXSetG9k9hw47cmnBcDCJ8ZOY7VYp8olNM1aoqfLxmMacPb4synjExxOkjVY17mz4gbi23LR050PuRh+jCWjM4WNJ+bMONQ2xrdiRRZHABt+XT9hHtKXg8hN7zSmLZa2SunTaIEdS/NnMBKBU1+H2+oiW5N9JAVeTHNPSn/WV2C90DttbkdejeCwqjpqX//Jm3TN/Jr8Nqg2wzLcMnE1/LJGrcleNOo4qb7Q1EW2a9q+UJNgpNhyFj5ETnhSe/yratSgb/WOGrtBM3bUeZ22WePdUdN/9ILq7md1f2yBKiB7e/72fg/c2ghtvNiYQsvX631jI8e7mYyc45u5v3ZCYNiht2eGq+DvEyNhDtv60njOmsOsmxJmZT+MVcwg2X07EoZ+BEqU0pJz1QxzNdu/YUmgVZx/AXqzXPPVTGiQeJ+7+Wzm7eFshxZ3RPkZ5jmcDkfXCYlmB2E2Yej5o7EXNRa+ksE0e8WM1pGHM21HD0cOomczbsqDEes3/PjV2AwZ4e//XAcOld4YdudT15DenJ2fnQ9G2g7P4vJiFP/i8iLMX0fg+bD8eBrnucmcl+0wxkM8Cqf0Nu2ntdN9y15Yj0z99Yn5PZnlKaoweTRNZH3Ryy5rOQHmg7l7FUFinGeTslyj4/pdVfy5Hgv5/qVyfMsPzLVDiP/hiDtKwo4OY2PvHtOCjcPQ24r4mUf9/q8m6X4QD0Vvi74+DGO2qAaXEB6LhFByb7UsG4NFHFM+hHuvsDD8LrE//nINdT83HEWPVT+cUo5hlWVtcW12pKuqQ+n5fwZYVf8Ci4Bq+w==
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"]},"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"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>