> Portal Navigation:
>
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt
# GetFolder
# Package: mediaManager
# Namespace: FoldersService
# Method link: https://dev.wix.com/docs/api-reference/assets/media/media-manager/folders/get-folder.md
## Permission Scopes:
Read Media Manager: SCOPE.DC-MEDIA.READ-MEDIAMANAGER
## Introduction
Gets information from a specific folder in the Media Manager.
---
## REST API
### Schema
```
Method: getFolder
Description: Gets information from a specific folder in the Media Manager.
URL: https://www.wixapis.com/site-media/v1/folders/{folderId}
Method: GET
# Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
Required parameters: folderId
Method parameters:
param name: folderId | type: none | required: true
Return type: GetFolderResponse
- name: folder | type: Folder | description: Information about the folder.
- name: id | type: string | description: Folder GUID. Generated when a folder is created in the Media Manager.
- name: displayName | type: string | description: Folder name as it appears in the Media Manager.
- name: parentFolderId | type: string | description: GUID of the folder's parent folder.
Default: `media-root` folder.
- name: createdDate | type: string | description: Date the folder was created.
- name: updatedDate | type: string | description: Date the folder was updated.
- name: state | type: State | description: State of the folder.
- enum: OK, DELETED
- name: siteId | type: string | description: Site GUID the folder belongs to.
```
### Examples
### Get information about a folder
```curl
curl -X GET \
'https://www.wixapis.com/site-media/v1/folders/12vn4498977596aeebcf5c41eca01c0d99667ac9' \
-H 'Authorization: '
```
---
## JavaScript SDK
### Schema
```
Method: wixClientAdmin.mediaManager.FoldersService.getFolder(folderId)
Description: Gets information from a specific folder in the Media Manager.
# Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
Required parameters: folderId
Method parameters:
param name: folderId | type: string | description: Folder GUID. | required: true
Return type: PROMISE
- name: _id | type: string | description: Folder GUID. Generated when a folder is created in the Media Manager.
- name: displayName | type: string | description: Folder name as it appears in the Media Manager.
- name: parentFolderId | type: string | description: GUID of the folder's parent folder.
Default: `media-root` folder.
- name: _createdDate | type: Date | description: Date the folder was created.
- name: _updatedDate | type: Date | description: Date the folder was updated.
- name: state | type: State | description: State of the folder.
- enum: OK, DELETED
- name: siteId | type: string | description: Site GUID the folder belongs to.
```
### Examples
### Get a folder (with elevated permissions)
```javascript
import { folders } from '@wix/media';
import { auth } from '@wix/essentials';
const elevatedGetFolder = auth.elevate(folders.getFolder);
/* Sample folderId value: '30ed8f8a8f1e4a99b82c516cb212192f' */
async function myGetFolderFunction(folderId) {
try {
const folder = await elevatedGetFolder(folderId);
console.log('Successfully retrieved folder:', folder);
return folder;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* {
* "_createdDate": "2023-08-22T08:31:06.000Z",
* "_id": "30ed8f8a8f1e4a99b82c516cb212192f",
* "_updatedDate": "2023-08-22T08:31:06.000Z",
* "displayName": "test2",
* "parentFolderId": "302fc049d70c41dea33fa4a27ab481ba",
* "state": "OK"
* }
*/
```
### Get a folder
```javascript
import { folders } from '@wix/media';
/* Sample folderId value: '30ed8f8a8f1e4a99b82c516cb212192f' */
async function myGetFolderFunction(folderId) {
try {
const folder = await folders.getFolder(folderId);
console.log('Successfully retrieved folder:', folder);
return folder;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* {
* "_createdDate": "2023-08-22T08:31:06.000Z",
* "_id": "30ed8f8a8f1e4a99b82c516cb212192f",
* "_updatedDate": "2023-08-22T08:31:06.000Z",
* "displayName": "test2",
* "parentFolderId": "302fc049d70c41dea33fa4a27ab481ba",
* "state": "OK"
* }
*/
```
### getFolder (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).
```javascript
import { createClient } from '@wix/sdk';
import { folders } from '@wix/media';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed
const myWixClient = createClient ({
modules: { folders },
// Include the auth strategy and host as relevant
});
async function getFolder(folderId) {
const response = await myWixClient.folders.getFolder(folderId);
};
```
---