get-a-single-bookmark.api.mdx•6.27 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: eJzNV01vGzcQ/SvEXNoCC8spUjTQzQnawC2aGI2LHgwdRsuRltYuuSG5smVh/3sw3E/JVLxODLQny8sZzuPjm+HMHiS51KrSK6NhDu/Ji6UxmwLtRix3QnknlIQEPK4dzG/gbbvoYJGAo7Syyu9gfrOHJaEle1H5DOY3i3qRQIkWC/JkXTBwaUYFwnwPflcSzMF5q/QaEqB7LMqcPylSMr/frYu72ze/mvuHX7J77036hhEoH0w6BJcS6gQsfa6UJQlzbytKQGPBRsvBKAHFJyvRZ1AnERhLY3JCDQlIWmGV+26vQ2ouV8KRF96IsNrT9IMTqdGetBd3Ks/FkoTSaV5JkkJp4TMSllxptKMz8cF4SoTP1OCUomafHO2axMpY4UxB/e7u7PCUK8zd/wdaz3e77bvGseP8c0V2ByyFLoxj3n8+P+c/h2f4uLyllHH6bFCgRI8cpQXEXliWuUqRvWa3jl0jV2rCZpBAaU1J1qsmsJKP1VcnkFpCT/LCR1cLI9VKxZcT0FWe45KFydTXvUwnWKJNM7UlGZFincAKt4aT69S6x/Va6fUnj75yT8dLgHRVcAa7Kk3JOeAQKq8sMU2kJXst6gRcVRRo1UOg+OW318ZPo6fBsZtGeqhOvSFaizsWoafCfbMsGmlHFtB7TDOSb6PgOiJQQQJZVaCGRX2QwzcQSmrY/2C3YDfSutH0cRVq59cP0KyehpIrvQnkVzaPnmi6aA+SdoK9KnBN/8TCnjK+cI78ZeRKYhpJLZF2mfHP8VpVeX7FkZoEfI5raSm1eJeT/AbnrZJkngUUtyqdSHTmi/zdIJ0n7btjTLPGymfGTqOoWubKZTTNWqKnq9ZjGins8Vdbkyc4HGVesG4SYcHdwPcllqd7HxIr/IhlljOVTScmQBxqF+N7sSILL4ANv66fMA+5yEHkanCK6ZZ1qnL6EK2WsZx9BiMJOPUw3lZXxZJsVM+TtR+neSBlOOsLsF7pjTZ3kScgOCzqntqXf78mXfNQQbtzfxp/WaLWZC9bLRwVTmhLGtu1HVuobhCpk5xzp6gIr+GAdlFHDYYu7aAnG/VRB03TcYcUb2za1mGQT38bi8cTB9QB2evz14/b185GaOPFylRavlzbmhoZb0QKco5v5vHaEYFhh8GeGa6Dv8+MhDmsm0vjEWkOs77Bn+2HOapmBsluu2kutBKwRyktOVfPsFSz7SuWBFrF2Ragt8sNX+1wBZn3pZvPZt7uzjZocUNUnmFZwvFcc52RaHcQZhXmlT9be9Fg4SsZDaKfmNEm8ngc7enhyHyOYMb9dDBi/YYfvxtbICP849/rwKHSK8PufOoG0quz87Pz0TTa47m4uoziv7i6DKPTAXg+LD+VxnnuD+f7bo7i+RuFU3qdD4PW8b77QVhfGdibE/PrMStzVGFoaPu/5qJv+qzlBJiPRuZFAplxnk32+yU6rtZ1zZ+biY7vXyrHt3xiJB1D/A+n0ygJG9rFJtYt5hUbh3m1E/Ezj/rj323S/SRORe9KvN6NY3aoRpcQnoaMUHIndbNvDS7SlMox3EeFheH3if3+t2tourfxFHmo+vGAcQhrv28srs2GdF33KD3/zwDr+gtMflJP
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},"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","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>