---
id: search-bookmarks
title: "Search bookmarks"
description: "Search bookmarks"
sidebar_label: "Search bookmarks"
hide_title: true
hide_table_of_contents: true
api: eJzNWEtv20YQ/ivEXNoChOT0qJsSpK1bNDZqFz0YPIzIobjRcpfehxxF4H8vZkmRlEzZVGKgPVnmzuOb587sHjKyqRGVE1rBAu4ITVpEK603JZqNhRgcri0sHuB99y2JwVLqjXA7WDzsYUVoyCy9K2DxkNRJDBUaLMmRsYHApgWVCIs9uF1FsADrjFBrqGMw9OiFoQwWzniKQWHJBI8Qg2BAj57MDur4vJAYSPmSEaJNIQ4GAQuWtEWVEsPNKEcvHSwGn4+U5yhtr91q425MRmYCCuXLFZmXpElRCneJPU44yR8+eGP1i6LThuJ12SutJaGCgSsafx+H/zqPLLnI6Sicdnnwg41SrRwpFz0JKaMVRUKl0meURUJFrqDIkK20sjSLPmlHceQK0TOlqJhHollTlGsTWV1Sn2WzURv/J9A6Z7diPzSMJ05P2IBGjWW//3x1xX+ObbhZfaaUcboiALNNtRmyXrqgqkXFrFhVUqTIrPPPlvlH4qqDRIihMroi40Sjva/fnhSNwR2jdlTa10WIbLReU0PoKFu60dNSZyIX48cxKC8lrji1OYR1l+gTKNlPYkvZSErXMeS41dyOzp07XK+FWt85dN6+rq/vKNanKVnugjkK6Q2xm0hlzJXUMVhflmjE1xCltxevtJvmngbHbprTQz9/47RoSmTkAJ3DtKDs/Si4rnMLiKHwJSpI6qNe8MAaW/lH0gLdoFy0ops83DYvG9CcnocihdoE53sjRy2anrRHxT+BXpS4pr/H1J4jXlpL7nokJGM5khoiZQvtLuHKvZS3rKkpwEtYK0OpwSdJ2Tcwb0VG+iKguBXpREcXrpQf+tR5lb5Ns0vgHCyfpgC9K7SZ5lW/ksIWNI06Q0e3Lcc04MzxZ9vGJzCcFGugbmon4UHk+2rR0RcXajH8GCtGq71JJ9bMONSDju/FipwcAWz4df8KeShfVpLlPdNYbnFqC0mfRhvsWJlf4JEYrPg6FNsOs+dL4Jvd3Dult/UNvO7VRumnkVsjMCR159q3v/ImhZlvk98G3WbYhg+euBt+WaFSZK7b7DjpvtD2RaZrJ7zQk2Ck2XIVnnNOuFJ7/Ek9StCPekeD3WAYO5q8Tses8emonT/6hOrik/SLz2HVBMal6ItrN6GLk2+4xw7kDFTd4looNrNfb+s6+KMkV+gMFrBuHIy83sK8Ezlvpne2k8z2sOqGqQH2mGWGrK3nWIn59h0HDo1goCGl2uNmQzispoVzlV3M587sZhs0uCGqZlhVcLoK3RcUtRIinYdN4o+WPmqwsA2DLf2O14Z2Mxjs6p03WXNITSbj0TkQcZaFH79oUyIj/P2f+xASoXLN7Gx1A+nd7Gp2NVhdOzzL2+tR/Mvb67BtHYFnY/mK09bxKLjYH1avkWeJk+Gq60+jTxiNmdzq55VEEZaCdr5r4nqcKm1kkxgKbR2f7vcrtNxV65o/N0sfxzsTlqN6Zmsd4vrxrzYxf4rOQdrQrn372KL0fB62+Wc6GrrhK8UU+sM7xBTa7mHhZeKzxv6H2/oLnn22wffWJX2FhkesGApC9i0HueFepilVQ65nGzpL6drGrx/voZnshkvpcWUN9xVUu4Hs/b6huNcbUnUNBxMc/w81t+x/AQnz0gw=
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={"Search bookmarks"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/bookmarks/search"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Search bookmarks

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"schema":{"type":"string"},"required":true,"name":"q","in":"query"},{"schema":{"type":"string","enum":["asc","desc","relevance"],"default":"relevance"},"required":false,"name":"sortOrder","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 the search results.","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"]},"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
  
</StatusCodes>


      