---
title: "Get Recommendations 2.0"
method: POST
path: "/api/v2/recommendations/list"
tags: ["Recommendations"]
---

# Get Recommendations 2.0

`POST /api/v2/recommendations/list`

## Request

- Base URL: `https://api.umbrellacost.io`
- URL: `https://api.umbrellacost.io/api/v2/recommendations/list`
- Auth: none declared. Required headers: `Authorization`, `apikey`

Retrieves recommendations according to status and other filters

## Headers

- `Authorization` string, required
- `apikey` string, required

## Request body

- object
  - `filters` string, required: see table above with all filters (json)
  - `sort` string[], required: sorting order of the response (json array)
  - `page_size` integer, required: max number of records to return in each page
  - `pagination_token	` string, required: The token should be copied from previous response to continue based on the pagination

## Response `200`

- object
  - `recId` string: Recommendation Id
  - `createdAt` string: Recommendation creation date
  - `createdAtDateTime` string: Recommendation creation date and time
  - `calculatedAtDateTime` string: Recommendation calculation date and time
  - `lastProcessingDate` string: The last date information for this recommendation was received
  - `annualSavings` integer: Calculated annual savings
  - `monthlySavings` integer: Monthly savings
  - `annualCurrentCost` integer: Annual current cost
  - `monthlyCurrentCost` integer: Monthly current cost
  - `age` integer: Recommendation age since creation
  - `cloudProvider` string: AWS, Azure, GCP
  - `typdId` string: Recommendation type Id in Umbrella Cost
  - `typeName` string: Recommendation type Name in Umbrella Cost
  - `linkedAccountId` string: Linked Account Id
  - `linkedAccountName` string: Linked Account Name
  - `resourceId` string: Resource included in the recommendation
  - `instanceType` string: Resource type / family type
  - `region` string: Resource related region
  - `service` string: Resource related service
  - `category` string: Umbrella cost recommendation categories (see table above)
  - `recommendedAction` string: The recommended action.
  - `customTags` string: custom tags
  - `enrichmentTags` string: enrichment tags
  - `starred` boolean: Is the recommendation starred in the Umbrella Cost App. Values: true / false
  - `comments` string: Recommendation comments in the Umbrella Cost App.
  - `labels` string: Recommendation labels added in the Umbrella Cost App.
  - `open` boolean: Is the recommendation open. Values: true / false
  - `viewed` boolean: Was the recommendation viewed by a user in the Umbrella Cost App. Values: true / false
  - `userStatus` string: * status: done/excluded/null * reason: exclusion reason/null * until: exclusion until date/null * period: null (deprecated)
  - `recData` string: Recommendation detailed information. Details may differ according to the recommendation type and resource type. The recommendation data will provide * Data regarding current use * Data regarding suggested use * Recommendation alternatives if they exist

---

[API](https://skmtc.dev/umbrellacost/apis/cost-usage.md) - [All operations](https://skmtc.dev/umbrellacost/apis/cost-usage/llms.txt) - [OpenAPI document](https://skmtc.dev/umbrellacost/apis/cost-usage/revisions/c5ae311d18ae?raw)