# Get Tenant Consumption by Folder

> Retrieves the consumption breakdown by folder for a specific tenant, with optional aggregation by folder ownership.

Use this endpoint to retrieve a consumption breakdown by folder for a specific tenant.

## API endpoint

`POST` `{accessURL}/lease_/api/usage/{organizationId}/tenants/consumption-by-folder`

Replace `{accessURL}` in all endpoint paths with the base URL for your cloud platform:

| Cloud platform | Access URL |
| --- | --- |
| Test Cloud | `https://cloud.uipath.com/` |
| Test Cloud Public Sector | `https://govcloud.uipath.us/` |
| Test Cloud Dedicated | `https://{customURL}.dedicated.uipath.com/` |

## Request headers

```
--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'
```

:::note
To obtain the `{access_token}`, make sure to authenticate through the ROPC method described [here](https://docs.uipath.com/test-cloud/automation-cloud/latest/api-guide/authentication-methods#authentication-methods).
:::

## Path parameters

| Path param | Data type | Description |
| --- | --- | --- |
| `organizationId` (required) | String (GUID) | The ID of the organization in which your tenant resides. |

## Request body

The request body specifies the tenant, date range, consumable code, and optional aggregation mode.
For a detailed list of consumable codes, refer to [Consumables](https://docs.uipath.com/test-cloud/automation-cloud/latest/api-guide/license-codes#consumables).

```json
{
  "tenantId": "string",
  "startDate": 0,
  "endDate": 0,
  "consumableCode": "string",
  "aggregateByOwnership": false
}
```

:::note
- `startDate` and `endDate` are Unix timestamps in milliseconds.
- `aggregateByOwnership` is optional (default: `false`). When set to `true`, consumption is aggregated by the folder that triggered the process execution rather than where it ran.
:::

## Responses

### 200 OK

Returns a list of consumption records grouped by folder for the specified tenant.

## Example request

The call should resemble the following example (cURL):

```
curl --location --request POST 'https://cloud.uipath.com/lease_/api/usage/11111111-1111-1111-1111-111111111111/tenants/consumption-by-folder' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "string",
  "startDate": 1704067200000,
  "endDate": 1706745600000,
  "consumableCode": "consumption_unit_code"
}'
```

Here's the response body for a successful consumption by folder retrieval:

```json
{
  "items": [
    {
      "folderKey": "string",
      "folderName": "string",
      "parentFolderKey": "string",
      "consumedBySelf": 0,
      "processCountSelf": 0
    }
  ]
}
```