aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.26.0/API/get-a-single-list.api.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'docs/versioned_docs/version-v0.26.0/API/get-a-single-list.api.mdx')
-rw-r--r--docs/versioned_docs/version-v0.26.0/API/get-a-single-list.api.mdx71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.26.0/API/get-a-single-list.api.mdx b/docs/versioned_docs/version-v0.26.0/API/get-a-single-list.api.mdx
new file mode 100644
index 00000000..a9ff6160
--- /dev/null
+++ b/docs/versioned_docs/version-v0.26.0/API/get-a-single-list.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-a-single-list
+title: "Get a single list"
+description: "Get list by its id"
+sidebar_label: "Get a single list"
+hide_title: true
+hide_table_of_contents: true
+api: eJytVMFu2zAM/RWDpw0QknTosMK3Hrai24AVW4cdghwYm4nVypIq0W0yQ/8+UHbTpE2HHXayLVLke3zP7KGmWAXtWTsLJVwQF0ZHLpbbQnMsdA0KGNcRyjl81ZEjLBREqrqgeQvlvIclYaBw3nED5XyRFgo8BmyJKcScEKuGWoSyB956ghIiB23XoIA22HojR5p0bTbbdftwc/bBbX6/bzbMrjqT7ppzinS/rCEpCHTX6UA1lBw6UmCxlQQzJCjQwsQjNyBoAkXvbKQoCN7NZvI4JP1teUMVFw+am4F8jYwTUFA5y2RZbqD3RlcoN6Y3Ua4dIeZyIVDgg/MUWA9Ndf2SfHqEfSRwgO7l1GxnDC5lJkI/KdDVscSUhSArM/mXKkPCEZFs14r6LdoODSiILQYWG9S0ws4wlI+xpOCuo7D9p36+Wxpd7aUunTOEFtKBxHPIHszDGqnuEduVWRwaBVKSMqez05dyS7ywjouV62z9/2SuXH1cz5ZixPWx2DOmucJT/iINLFrixtVQwppyV3F2CVOxapz2g+2TCEPh/vGn64KBEnqs60Axpil6Pb0/AQX3GLTokCGP4WFGj2I2zD6W0ymH7eQWA94S+Ql6D8+cCdcNFWOFwq0Kbqj4MuYXAxaRYW9f/JBJDp33t8ZuLNJZeOQ0cUROAjW+fHKhRUH4+dd1np22KyfXhfUA6WQym8z2lsYOz/nV5VH851eXxcqFQ/BCVhzqIreYPTCuGFmPWERt14byqnhes38y0yu7dGDKtOGpN6itNMpi9aOw87zIIigox422UNC4yBLq+yVG+hlMSnI8/m3zxZOuWf1aR3mvoVyhifQXkG++j/57W7yGbjxEu832MZ18gYJb2j5t3bRIChrCmkJGMATPq4o871178X+JPXb+vvh4DQrw0BTPTJCrH4XU90PGtbslm9IOIcu3AEzpD17EW8M=
+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 list"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/lists/{listId}"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get list by its id
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+ \ No newline at end of file