From 5da682b7e986f379ccd9eefba20deb6a2c9aa17f Mon Sep 17 00:00:00 2001 From: Chiranjeevinarukula <149758615+Chiranjeevinarukula@users.noreply.github.com> Date: Thu, 29 Feb 2024 16:59:01 +0530 Subject: [PATCH] docs: Add documention for folder list via API (#32) * docs: Add documention for folder list via api --- docs/server-api/folders.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/docs/server-api/folders.md b/docs/server-api/folders.md index db727517..d738fd71 100644 --- a/docs/server-api/folders.md +++ b/docs/server-api/folders.md @@ -39,4 +39,35 @@ For valid requests the API server returns a JSON: "uuid": "46seZZHAnWE", // folder id } -``` \ No newline at end of file +``` + +## Get all the Folders that belong to the organization +To get all folders in the organization, you need to send an HTTP GET request to the API Endpoint, with the [authentication Header](../server-api/authentication.md). + +```bash +https://app.tpstreams.com/api/v1//assets/folders/ +``` + +For valid requests the API server returns a JSON: + +```json +{ + "count": 3, + "next": null, + "previous": null, + "results": [ + { + "title": "Aes files", + "uuid": "6bBcXxu5cAM" + }, + { + "title": "Drm videos", + "uuid": "BmN3MXSq5z6" + }, + { + "title": "AES encrypted Videos", + "uuid": "nD8K9nJ3Bsm" + }, + ] +} +```