---
id: search-bookmarks
title: "Search bookmarks"
description: "Search bookmarks"
sidebar_label: "Search bookmarks"
hide_title: true
hide_table_of_contents: true
api: eJzNWEtv4zYQ/ivCXNoCgp3t0Tdv0BZp0d2gSdFDoMNYGllcU6TCh7Ouof9eDCVbskMnSjdAe4oizgy/eWo+76EgmxvROKEVLOCO0ORVstJ6U6PZWEjB4drC4gE+Ht9lKVjKvRFuB4uHPawIDZmldxUsHrI2S6FBgzU5MjYI2LyiGmGxB7drCBZgnRFqDW0Khh69MFTAwhlPKSisWeARUhAM6NGT2UGbRowoX6/InBopUdrBihS1cBMs9XBScMJJfnHtjdUvms47iddtr7SWhApSKKhEL93B09PA35SJJZc4nYTTYwa+s0mulSPlkichZbKiRKhc+oKKRKjEVZQYso1WlmbJJ+0oTVwlBqUcFetINGtKSm0Sq2sa8juL+vg/gXYMdm/2ulM8C3rGDnTXWI77j1dX/OfUh8+rL5QzTlcFYLarc0PWSxeu6lGxKjaNFDmy6vyLZf1IXnWwCCk0RjdknOhuHzpnEEVjcMeoHdX2dROiiHZKbggdFUsXPa11IUoRP05BeSlxxaXNKWyPhT5BkuMktlRESrpNocSt5kFw6dzhei3U+s6h8/b1+1Ig5WueNtbnOVmePyUK6Q1xmEgVrJW1KSjtpuG3vq7R7KZFJYy6d85bV8ORA3QO84qKj1Fwh0CggBQqX6OCrD1p1ge+sbd/Yi3IjepZK/pchkH8sgPd6WUoUqhNCL43MurR9Ko66c4J8qLGNf0Zu/aS8NJacjeRlMRqJDdEylbavUWr9FLe8k1dh7xFtTGUG3ySVPwL5a0oSL8JKG5FPjHQlavl9VA6r8of3Jgmjd5V2kwLkV9JYSuaJl2go9teY1pQWOP3fmhOUDjrvCDdNULGn/1vayxHX11orPAQ6yyrvcknNkAc6uGOb8WKXHgBbHi6f0U89CJfUpSDUqxuuU6FpE/RaRnr2TdEJAUr/h6b7VfHWD1Prv14mIegDL6+Q9S92ij9FPkEBIWsPYb2/b9fk9I8TNCD33fjNytUisxNXwtngxP6kcZy/fYUphtE5iT33KVQhK/hgDZrowLDGnWyNI0WnZOt5nyF6ZeEoVCOcc8G+nCgSsAIFH11PZ94c1GNedjIzuiqW1wLxQ4N9Kxtg+c1uUoXsIB1F0pkegbzo8l5twMDkzmzPVC18GmHPRaFIWvbOTZivv3AKUIjGGgolf6427N7VgOVc41dzOfO7GYbNLghambYNHBOKO4rSnoLiS7DPv5bL590WNiHEcu84+W7369HXPMYTb6Z/QhivIAGIa6n8PCzNjUywl//ug8pEarUrM5ed5A+zK5mVyMCeMSzvL2J4l/e3gTOcgKeneVPl7aO97XF/kBgIrT6bAM6zp0oBe/c5BE+bySKsFr3S1iX19NS6TObpVBp6/h0v1+h5WnZtvy6o06c70JYzuoF7jfG9f0ffWH+kFyCtKFdz923KD2fB0787I5O7sDOp8ge6fbLwhfB/4cc9oVIPeO1g3fZ0HHhR5UUKsKCt6GHfa+9zHNqxlrPeCtbOY6BX366h24DG1O1004ZkwRUu5Ht/b6TuNcbUm0LBxcc/w8tD9t/ABEfUog=
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":"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"]},"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>