Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add documentation for folder list via API #32

Merged
merged 3 commits into from
Feb 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion docs/server-api/folders.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,35 @@ For valid requests the API server returns a JSON:
"uuid": "46seZZHAnWE", // folder id
}

```
```

## 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/<organization_id>/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"
},
]
}
```