Skip to main content
GET
/
recommendations
Get all recommendations
curl --request GET \
  --url https://api.vantage.sh/v2/recommendations \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "self": "https://api.vantage.sh/v2/recommendations",
    "first": "https://api.vantage.sh/v2/recommendations?page=1",
    "next": null,
    "last": "https://api.vantage.sh/v2/recommendations?page=1",
    "prev": null
  },
  "recommendations": [
    {
      "token": "rcmmndtn_9bb8fa992d5b876b",
      "type": null,
      "category": "ip_unattached",
      "workspace_token": "wrkspc_e0e58b3c1ddef29c",
      "provider": "aws",
      "provider_account_id": "123456789012",
      "description": "IP address is not attached to an instance.",
      "potential_savings": "100.0",
      "service": "AWS IP",
      "created_at": "2026-01-28T16:53:32Z",
      "resources_affected_count": 0,
      "currency_code": "USD",
      "currency_symbol": "$"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
provider_ids
enum<string>[]

Filter by one or more providers. Requires workspace_token.

Available options:
aws,
gcp,
azure,
kubernetes,
datadog
​
billing_account_ids
string[]

Filter by billing account identifiers. Requires workspace_token.

​
account_ids
string[]

Filter by account identifiers. Requires workspace_token.

​
regions
string[]

Filter by region slugs (e.g. us-east-1, eastus, asia-east1). Requires workspace_token.

​
tag_key
string

Filter by tag key (must be used with tag_value). Requires workspace_token.

​
tag_value
string

Filter by tag value (requires tag_key). Requires workspace_token.

​
start_date
string

Filter recommendations created on/after this YYYY-MM-DD date. Requires workspace_token.

​
end_date
string

Filter recommendations created on/before this YYYY-MM-DD date. Requires workspace_token.

​
status
enum<string>

Filter by status.

Available options:
active,
archived
​
page
integer<int32>

The page of results to return.

​
limit
integer<int32>

The number of results to return. The maximum is 1000.

​
workspace_token
string

Filter by workspace.

​
provider_account_id
string

Filter by provider account id (AWS account, Azure subscription id, etc).

​
category
string

Filter by exact recommendation category. Ignored when type is provided.

​
type
string

Fuzzy filter by recommendation type using a case-insensitive literal substring. Examples: aws, aws:ec2, aws:ec2:rightsizing.

​
provider
enum<string>

Filter by provider.

Available options:
aws,
gcp,
azure,
kubernetes,
datadog

Response

200 - application/json

Recommendations model

​
recommendations
object[]
required
​
links
object