> 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

# GetPortfolioSettings

# Package: portfolio

# Namespace: PortfolioSettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/portfolio/portfolio-settings/get-portfolio-settings.md

## Permission Scopes:
Manage Portfolio: SCOPE.PORTFOLIO.MANAGE-PORTFOLIO

## Introduction

Retrieves a site's portfolio settings.

---

## REST API

### Schema

```
 Method: getPortfolioSettings
 Description: Retrieves a site's portfolio settings.
 URL: https://www.wixapis.com/portfolio/portfolio-app/api/v1/portfolio/settings
 Method: GET
 Return type: GetPortfolioSettingsResponse
  - name: portfolioSettings | type: PortfolioSettings | description: Portfolio settings. 
     - name: revision | type: string | description: Revision number. Increments by 1 each time the portfolio settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the portfolio settings object. 
     - name: projectItemSettings | type: ProjectItemSettings | description: Portfolio's project item settings. 
        - name: addItemDirection | type: AddItemDirection | description: The direction in which to add new project items to a gallery. Default: `GALLERY_START` 
             - enum:
             -     GALLERY_START: Add new project items to the beginning of the gallery.
             -     GALLERY_END: Add new project items to the end of the gallery.
        - name: defaultItemName | type: DefaultItemName | description: Default title assigned to a project item if no title is provided. Default: `FILE_NAME` 
             - enum:
             -     FILE_NAME: File name assigned as the title.
             -     EMPTY: No title assigned.
     - name: mediaSettings | type: MediaSettings | description: Portfolio's media settings. 
        - name: folderId | type: string | description: GUID of the folder containing the media. 
     - name: createdDate | type: string | description: Date and time the portfolio settings were created. 
     - name: updatedDate | type: string | description: Date and time the portfolio settings were updated. 


```

### Examples

### Get Portfolio Settings
```curl
curl -X GET \
'https://www.wixapis.com/portfolio/v1/settings' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.portfolio.PortfolioSettingsService.getPortfolioSettings()
 Description: Retrieves a site's portfolio settings.
 Return type: PROMISE<GetPortfolioSettingsResponse>
  - name: portfolioSettings | type: PortfolioSettings | description: Portfolio settings. 
     - name: revision | type: string | description: Revision number. Increments by 1 each time the portfolio settings object is updated. To prevent conflicting changes, the existing revision must be passed when updating the portfolio settings object. 
     - name: projectItemSettings | type: ProjectItemSettings | description: Portfolio's project item settings. 
        - name: addItemDirection | type: AddItemDirection | description: The direction in which to add new project items to a gallery. Default: `GALLERY_START` 
             - enum:
             -     GALLERY_START: Add new project items to the beginning of the gallery.
             -     GALLERY_END: Add new project items to the end of the gallery.
        - name: defaultItemName | type: DefaultItemName | description: Default title assigned to a project item if no title is provided. Default: `FILE_NAME` 
             - enum:
             -     FILE_NAME: File name assigned as the title.
             -     EMPTY: No title assigned.
     - name: mediaSettings | type: MediaSettings | description: Portfolio's media settings. 
        - name: folderId | type: string | description: GUID of the folder containing the media. 
     - name: _createdDate | type: Date | description: Date and time the portfolio settings were created. 
     - name: _updatedDate | type: Date | description: Date and time the portfolio settings were updated. 


```

### Examples

### getPortfolioSettings
```javascript
import { portfolioSettings } from '@wix/portfolio';

async function getPortfolioSettings() {
  const response = await portfolioSettings.getPortfolioSettings();
};
```

### getPortfolioSettings (with elevated permissions)
```javascript
import { portfolioSettings } from '@wix/portfolio';
import { auth } from '@wix/essentials';

async function myGetPortfolioSettingsMethod() {
  const elevatedGetPortfolioSettings = auth.elevate(portfolioSettings.getPortfolioSettings);
  const response = await elevatedGetPortfolioSettings();
}
```

### getPortfolioSettings (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 { portfolioSettings } from '@wix/portfolio';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { portfolioSettings },
  // Include the auth strategy and host as relevant
});


async function getPortfolioSettings() {
  const response = await myWixClient.portfolioSettings.getPortfolioSettings();
};
```

---