---
id: get-all-highlights
title: "Get all highlights"
description: "Get all highlights"
sidebar_label: "Get all highlights"
hide_title: true
hide_table_of_contents: true
api: eJyNVU1v2zAM/SsGz0LS7uhbMGxrd1mBddihyIGxmVirLHkU3S0w9N8H2k5it267XJLIT4+PX88dlBQLto3Y4CGHLyQZOpdV9lA5e6gkggHBQ4T8AW4uh1sDkYqWrRwhf+hgR8jEm1YqyB+2aWugQcaahDj2gFhUVCPkHcixIcjBt/WOGJIBpt+tZSoh36OLZMBjrQhnaytgwKqw3y3xEZJZYIrC1h9UpxWnBx9bjuFN6mJAzLm3io9N8JGi0n+4utKveYG+7X5RIdkfK9WzQmUlCq7AQBG8kBe9i03jbIF6d/0rKsGC/tBTgoGGQ0Msdgg/acEFi8x4VN1CdXyfYxfCY438eFu+rFcyEAVZvu33kWSxM+TLN54WwQVe6gP5ttZ5OZJz4Q9oWUswcGAiDwZ2riUdoJL22DqB/ARMBoT+yhKlb53DnXZXuKVkwAeh/wLa5dTbSPxKVQomFCo3C0LSbKYepvWdV3NauzGrUXOv6Bx/Gm17meDzpvURPf2Vcabfz/iZwtkiT4gmwe7wYL1qmOx30o+BmqQKJeRw6PNoUPcb1jPSSPx02vKWHeTQYVkyxZjW2Nj10zUYeEK2KrKfyvHxsFynGahEmpiv18LHVRWQS+IVNg2YZwt4X1E2EmRhn0lF2QjPBiWqfWJP33Xdxm2YmNS5jhpXs+hhkI8gHdP+x+fANaq+rz/v+2ZYvw96XXMeFF2vrlZXE/u5GeVs7m4X1W/ubrN94F76CauZJgNNiFJjbxOjUy0a8oyzuxjOK/Y9JKpDuG4cWt/Pv3aqGzs6G5OtgSpE0dOu22GkH+xS0uPBJ7XPpY3azYuvPtJx4thPqCueQ+/Xr2DPFnwBby9z0r9FDFSEJXEfcri1KQpqpiFeOKyynMf2y6d7MIDzjj/rcM9+sld/nHB33YC4D4/kU4KTdNH/kLYppX8AOXqa
sidebar_class_name: "get api-method"
info_path: API/hoarder-api
custom_edit_url: null
hide_send_button: true
---

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 all highlights"}
>
</Heading>

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



Get all highlights

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

<ParamsDetails
  parameters={[{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"Object with all highlights data.","content":{"application/json":{"schema":{"type":"object","properties":{"highlights":{"type":"array","items":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}},"nextCursor":{"type":"string","nullable":true}},"required":["highlights","nextCursor"],"title":"PaginatedHighlights"}}}}}}
>
  
</StatusCodes>


      