aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.23.1/API/get-a-single-bookmark.api.mdx
blob: dd3625727dd95685a7f59096392d3d036fe1dfed (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
---
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: eJytV8Fu4zYQ/RVhTi0gxNliiy508xbtNgXaDZoUPRg+jMWxxVgiteTIiVfQvxdDyZbsKImym5Nl8Q355vENNaxBkU+dLllbAwl8Io5W1m4LdNtotY80+0griIFx4yFZwMdu0MMyBk9p5TTvIVnUsCJ05OYVZ5Asls0yhhIdFsTkfAD4NKMCIamB9yVBAp6dNhuIgR6wKHN5pUmr/GG/Ke7vPvxiH77+nD0w2/SDMNAcIAcGVwqaGBx9qbQjBQm7imIwWAho1YNi0JJZiZyBsHLkS2s8eWHy0+Wl/JyK8Hl1RylH95qzXgyFjBcQQ2oNk2GJwrLMdYoSNbvzEjqSpA2TQQylsyU51u3CWj0WookhdYRMas6jo4VVeq3Hh2MwVZ7jSjQSKZqjYhOQ6NJM72jIaWVtTmhk2TXurOzzU+OMm402mxtGrvzL68VApirETL5KU/IeZAmdV45EJjJKopZNDMbyNP6+Kgp0+2mqBCcfgegc7sUkTIX/5n1rbTcygMyYZqQ+jpI7CIEaYsiqAg0smxNXLyCUX5j/ZLaAG5jRGvq8DnX2fALt6NNUcm22QfzK5aMZTXfVSVVNwOsCN/Tv2LJPgefeE1+NbMmYR1JHZHxm+TVR6yrPr2WltkJeE1o6Sh3e56S+IXinFdlXEcWdTicKnXGR/9pb50X8IY1paKw4s26aRNUq1z6jaWiFTNddxDRRJOKv7tCcEHBWeQHdFsKyib+3sJgeOBRWeBirLG8rl04sgHGqhzW+lyuK8QLZ8HT7AjzUoiyi1n3QmG/Fpzqnv0dPy7GafYUiMXj9dTitqYoVuVE/T/b+uMy9KH2ub6B6ZbbG3o98AkLAsjlK+/bfr0nb3J+gh7xvhm9WaAy5q84LZwcndEea4LqWKpxuMHJOSs09JUX4GvZsl80ooG+jTpqmQaNz0tWctzBdk9Ab5aj78nEfCk3g8P7y/eNO8oCJjOVobSuj3q6DTK0abzkK8l724PHYmVRhhh4vWjYhnjOrIIFNuz3SOCcwO2ybn9V9d92A3ALc7tDjh6YBalTKkffNDEs9272TzUenpa4C9W641WuNVc6QQMZc+mQ2Y7e/yCw6Re4CyxLO+gi4zSjqJojsOuKMog4etUxkQwaXkxvRs113eEU5iiPrShYBJo1tAIlPw8Pv1hUo/P787zYoqM3aSrjk3DJ6d3F5cTm4ofzR0ZlfX42yn19fRWvrAvUDVjKVD6L1LF1gUh9uMnIjw8hrs8npeBs5n7buTfXMFa7NV74RszJHHXr3rstrN3lxrE0xfzK4RC1jyKxngdT1Cr2cyU0jr79UJI33YtnvcXCC0l6eFSRrzD09Q/iHfzpP/hg9xfJw1pl9sFJeyT+IYUv708teOCMzQiUtxaLuAPM0pZIHoY/qTgxz9P2n326hbWOG951TWww77VNadd0ibu2WTNMcWbL8F4JN8z/lr1XF
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 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"}]}
>
  
</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"]},"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"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
  
</StatusCodes>