mirror of
https://github.com/karakeep-app/karakeep.git
synced 2025-12-12 20:35:52 +01:00
4296e7f4d8
* refactor: Rename remaining project configuration from Hoarder to Karakeep * some fixes --------- Co-authored-by: Mohamed Bassem <me@mbassem.com>
71 lines
2.8 KiB
Plaintext
71 lines
2.8 KiB
Plaintext
---
|
|
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: eJytVE1v2zAM/SsGTxsgxOnQYYVvOWxdhwErtg47BD4oFhOrtSVXott4hv77QNlpvtxhh538QYp8j++JPSj0hdMNaWsgg2ukpNKeklWXaPKJViCA5MZDtoSv2pOHXIDHonWaOsiWPaxQOnSLlkrIlnnIBTTSyRoJnY8JviixlpD1QF2DkIEnp80GBOBW1k3FvzRqVW27Tf18f/XBbn+/L7dEtrji7ppiCne/URAEOHxstUMFGbkWBRhZc0I1JAjQzKSRVAKjcegbazx6RvBuPufHMelvq3ssKHnWVA7klSQ5AwGFNYSG+IRsmkoXkk+k956PTRCzsRAIaJxt0JEemmp1Tj7sYE8EjtCdT820VSVXPBOmHwToYioxRCHQ8Ez+pcqQMCGSaWtWv5amlRUI8LV0xDZQuJZtRZDtYkHAY4uu+4d+RzIuIfosDmSkcwA+P/YAhMCnL+eX50pyPDGWkrVtjfp/ChZWTUtVo/dyMxU7IRgr7PPzMLCokUqrIIMNxq5s2gxSdqFP+8HRgWeO7ml3n1pXQQa9VMqh9yGVjU6fLkDAk3SaRxwhj+FhRjudSqLGZ2lKrpuVVjqFbiabBk48B3clJmOBxK4TKjEZ05MBCYtwsAh+8ByHvofr4GUo3JdZxDTIxiQQ48sn62rJ+L78uouT02Zt+ThzHhBdzOaz+cE2+DzCWdzeTKJf3N4ka+si9F0uM+VbYT3VMuo/bg7eejLx2mwqjBvgtGS/N9IrK3LgSbiltKmkNtwoCtWPoi7jfvIgIBsXVS6gtJ441Pcr6fGnq0Lg3+MlWuZ7TaPySnt+V5CtZeXxLyDffB+99zZ5Dd34U5ouWqdq+QsEPGC3X6YhDwJKlApdRDAEF0WBDR0cO7tbbI4Xb19/vAMB8tgSJxaI1Sch9f2QcWcf0ITwgpD4mwGG8AcMME3z
|
|
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}},"required":["id","name","icon","parentId"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|