---
title: "How do I create a portfolio group?"
slug: "how-do-i-create-a-portfolio-group"
updated: 2024-08-30T14:52:18Z
published: 2024-08-30T14:52:18Z
canonical: "support.lusid.com/how-do-i-create-a-portfolio-group"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.lusid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How do I create a portfolio group?

Providing you have suitable [access control permissions](/v1/docs/identity-management-and-access-control-iam), you can create a [portfolio group](/v1/docs/what-is-a-portfolio-group) to act as a container for a set of related portfolios.

You can nest portfolios and/or sub-groups at the same time as you create the portfolio group, or subsequently.

- Method 1: [Using the LUSID REST API](/v1/docs/how-do-i-create-a-portfolio-group#using-the-lusid-rest-api)
- Method 2: [Using the LUSID web app](/v1/docs/how-do-i-create-a-portfolio-group#using-the-lusid-web-app)
- Method 3: [Using Luminesce](/v1/docs/lusidportfoliogroupwriter)

## Using the LUSID REST API

See also [this Jupyter Notebook](https://github.com/finbourne/sample-notebooks/blob/master/examples/use-cases/ibor/Portfolio%20types%20and%20portfolio%20groups%20in%20LUSID.ipynb) for more examples using the Python SDK.

1. [Obtain an API access token](/v1/docs/how-do-i-obtain-and-use-a-short-lived-api-access-token-from-okta).
2. Call the LUSID [CreatePortfolioGroup](https://www.lusid.com/docs/api#operation/CreatePortfolioGroup) API for your LUSID domain, specifying a scope in the URL and, in the body of the request:
  - A `displayName`.
  - A `code` that is unique within the scope.
  - Optionally in the `values` collection, the scope and code of one or more transaction, derived transaction or reference portfolios held directly within the portfolio group. Alternatively, you can perform this operation afterwards using the [AddPortfolioToGroup](https://www.lusid.com/docs/api#operation/AddPortfolioToGroup) API.
  - Optionally in the `subGroups` collection, the scope and code of one or more portfolio groups held as sub-groups. You can nest portfolio groups up to five levels deep. Alternatively, you can perform this operation afterwards using the [AddSubGroupToGroup](https://www.lusid.com/docs/api#operation/AddSubGroupToGroup) API.
  - Optionally in the `properties` collection, one or more [custom properties](/v1/docs/properties) from the `PortfolioGroup` domain to extend the data model.

For example, to create a portfolio group with a scope of `Ibor` (in the URL) and code of Global (in the body) that contains two nested portfolios and one sub-group:

```json
curl -X POST 'https://<your-domain>.lusid.com/api/api/portfoliogroups/Ibor'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "code": "Global",
  "created": "2023-07-03T00:00:00.0000000+00:00",
  "values": [
    {
      "scope": "Finbourne-Examples",
      "code": "UK-Benchmark"
    },
    {
      "scope": "Finbourne-Examples",
      "code": "UK-Equities"
    }
  ],
  "subGroups": [
    {
      "scope": "Finbourne-Examples",
      "code": "Finbourne-Examples-Fund"
    }
  ],
  "properties": {},
  "displayName": "Global portfolio group",
  "description": "A portfolio group representing global operations"
}'
```

## Using the LUSID web app

1. Sign in to the [LUSID web app](https://www.lusid.com/app) using the credentials of a LUSID administrator.
2. From the top left menu, select **Data Management > Groups**.
3. Click the **Create group** button (top right) and fill out the screen:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/0339463c-cd13-44ff-ab34-d18da9fcb5e0.png)
