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

# Get all recommendations

> Return all Recommendations. Use the `type` query parameter with a fuzzy fragment to filter recommendation type case-insensitively (for example: aws, aws:ec2, aws:ec2:rightsizing).



## OpenAPI

````yaml https://api.vantage.sh/v2/oas_v3.json get /recommendations
openapi: 3.0.1
info:
  title: Vantage
  description: Vantage API
  termsOfService: https://www.vantage.sh/terms-of-use
  contact:
    name: Vantage Support
    url: https://www.vantage.sh
    email: support@vantage.sh
  version: 2.0.0
servers:
  - url: https://api.vantage.sh/v2
security:
  - oauth2:
      - read
tags:
  - name: AccessGrants
    description: Operations about AccessGrants
  - name: AnomalyAlerts
    description: Operations about AnomalyAlerts
  - name: AnomalyNotifications
    description: Operations about AnomalyNotifications
  - name: AuditLogs
    description: Operations about AuditLogs
  - name: BillingProfiles
    description: Operations about BillingProfiles
  - name: BillingRules
    description: Operations about BillingRules
  - name: BudgetAlerts
    description: Operations about BudgetAlerts
  - name: Budgets
    description: Operations about Budgets
  - name: BusinessMetrics
    description: Operations about BusinessMetrics
  - name: Canvases
    description: Operations about Canvases
  - name: CostAlertEvents
    description: Operations about CostAlertEvents
  - name: CostAlerts
    description: Operations about CostAlerts
  - name: CostProvider
    description: Operations about CostProviders
  - name: CostProviderAccounts
    description: Operations about CostProviderAccounts
  - name: Costs
    description: Operations about Costs
  - name: CostService
    description: Operations about CostServices
  - name: Dashboards
    description: Operations about Dashboards
  - name: DataExports
    description: Operations about DataExports
  - name: ExchangeRates
    description: Operations about ExchangeRates
  - name: FinancialCommitmentReports
    description: Operations about FinancialCommitmentReports
  - name: FinancialCommitments
    description: Operations about FinancialCommitments
  - name: Folders
    description: Operations about Folders
  - name: Integrations
    description: Operations about Integrations
  - name: Invoices
    description: Operations about Invoices
  - name: KubernetesEfficiencyReports
    description: Operations about KubernetesEfficiencyReports
  - name: ManagedAccounts
    description: Operations about ManagedAccounts
  - name: Me
    description: Operations about Mes
  - name: NetworkFlowReports
    description: Operations about NetworkFlowReports
  - name: OpenAPISpecification
    description: Operations about OpenAPISpecifications
  - name: Ping
    description: Operations about Pings
  - name: Prices
    description: Operations about Prices
  - name: Recommendations
    description: Operations about Recommendations
  - name: RecommendationViews
    description: Operations about RecommendationViews
  - name: ReportNotifications
    description: Operations about ReportNotifications
  - name: ResourceReports
    description: Operations about ResourceReports
  - name: Resources
    description: Operations about Resources
  - name: SavedFilters
    description: Operations about SavedFilters
  - name: Segments
    description: Operations about Segments
  - name: Tags
    description: Operations about Tags
  - name: Teams
    description: Operations about Teams
  - name: UnitCosts
    description: Operations about UnitCosts
  - name: UserFeedback
    description: Operations about UserFeedbacks
  - name: Users
    description: Operations about Users
  - name: VirtualTags
    description: Operations about VirtualTags
  - name: Workspaces
    description: Operations about Workspaces
paths:
  /recommendations:
    get:
      tags:
        - Recommendations
      summary: Get all recommendations
      description: >-
        Return all Recommendations. Use the `type` query parameter with a fuzzy
        fragment to filter recommendation type case-insensitively (for example:
        aws, aws:ec2, aws:ec2:rightsizing).
      operationId: getRecommendations
      parameters:
        - name: provider_ids
          in: query
          description: Filter by one or more providers. Requires workspace_token.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - aws
                - gcp
                - azure
                - kubernetes
                - datadog
        - name: billing_account_ids
          in: query
          description: Filter by billing account identifiers. Requires workspace_token.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: account_ids
          in: query
          description: Filter by account identifiers. Requires workspace_token.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: regions
          in: query
          description: >-
            Filter by region slugs (e.g. us-east-1, eastus, asia-east1).
            Requires workspace_token.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - name: tag_key
          in: query
          description: >-
            Filter by tag key (must be used with tag_value). Requires
            workspace_token.
          schema:
            type: string
        - name: tag_value
          in: query
          description: Filter by tag value (requires tag_key). Requires workspace_token.
          schema:
            type: string
        - name: start_date
          in: query
          description: >-
            Filter recommendations created on/after this YYYY-MM-DD date.
            Requires workspace_token.
          schema:
            type: string
        - name: end_date
          in: query
          description: >-
            Filter recommendations created on/before this YYYY-MM-DD date.
            Requires workspace_token.
          schema:
            type: string
        - name: status
          in: query
          description: Filter by status.
          schema:
            type: string
            enum:
              - active
              - archived
        - name: min_savings
          in: query
          description: >-
            Filter by recommendations whose potential savings are greater than
            or equal to this amount, in the workspace's currency. Requires
            workspace_token.
          schema:
            type: number
            format: float
        - name: page
          in: query
          description: The page of results to return.
          schema:
            type: integer
            format: int32
        - name: limit
          in: query
          description: The number of results to return. The maximum is 1000.
          schema:
            type: integer
            format: int32
        - name: workspace_token
          in: query
          description: Filter by workspace.
          schema:
            type: string
        - name: provider_account_id
          in: query
          description: >-
            Filter by provider account id (AWS account, Azure subscription id,
            etc).
          schema:
            type: string
        - name: category
          in: query
          description: >-
            Filter by exact recommendation category. Ignored when type is
            provided.
          schema:
            type: string
        - name: type
          in: query
          description: >-
            Fuzzy filter by recommendation type using a case-insensitive literal
            substring. Examples: aws, aws:ec2, aws:ec2:rightsizing.
          schema:
            type: string
        - name: provider
          in: query
          description: Filter by provider.
          schema:
            type: string
            enum:
              - aws
              - gcp
              - azure
              - kubernetes
              - datadog
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recommendations'
              example:
                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.
                    documentation_url: >-
                      https://handbook.vantage.sh/aws/services/ec2-other-pricing/#stranded-resources
                    potential_savings: '100.0'
                    service: AWS IP
                    created_at: '2026-01-28T16:53:32Z'
                    resources_affected_count: 0
                    currency_code: USD
                    currency_symbol: $
      security:
        - oauth2:
            - read
components:
  schemas:
    Recommendations:
      required:
        - recommendations
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        recommendations:
          type: array
          items:
            $ref: '#/components/schemas/Recommendation'
      description: Recommendations model
    Links:
      type: object
      properties:
        self:
          type: string
          description: The URL of the current page of results.
          nullable: true
        first:
          type: string
          description: The URL of the first page of results.
          nullable: true
        next:
          type: string
          description: The URL of the next page of results, if one exists.
          nullable: true
        last:
          type: string
          description: The URL of the last page of results, if one exists.
          nullable: true
        prev:
          type: string
          description: The URL of the previous page of results, if one exists.
          nullable: true
    Recommendation:
      required:
        - category
        - created_at
        - description
        - documentation_url
        - potential_savings
        - provider
        - provider_account_id
        - resources_affected_count
        - service
        - token
        - type
        - workspace_token
      type: object
      properties:
        token:
          type: string
          nullable: false
        type:
          type: string
          description: >-
            The type of the Recommendation. This is analogous to category, but
            with a uniform format.
          nullable: false
          example: aws:ec2:co-rightsizing
        category:
          type: string
          description: The category of the Recommendation.
          nullable: false
          example: ec2_compute_optimizer_recommender
        workspace_token:
          type: string
          description: The token for the Workspace the Recommendation is a part of.
          nullable: false
        provider:
          type: string
          description: The provider the Recommendation is for.
          nullable: false
        provider_account_id:
          type: string
          description: >-
            The account ID of the provider. For Azure, this is the subscription
            ID.
          nullable: true
        description:
          type: string
          nullable: false
        documentation_url:
          type: string
          description: A URL to related documentation if available.
          nullable: true
          example: >-
            https://handbook.vantage.sh/aws/services/s3-pricing/#intelligent-tiering
        potential_savings:
          type: string
          description: >-
            The monthly potential savings of the Recommendation, converted to
            the organization's selected currency.
          nullable: true
          example: '100.00'
        service:
          type: string
          description: The service the Recommendation is for.
          nullable: false
          example: Amazon EC2
        created_at:
          type: string
          description: >-
            The date and time, in UTC, the Recommendation was created. ISO 8601
            Formatted.
          nullable: false
        resources_affected_count:
          type: integer
          description: >-
            The number of ProviderResources related to the Recommendation. Use
            the `recommendations/:token/resources` endpoint to get the full list
            of resources.
          format: int32
          nullable: false
        currency_code:
          type: string
          description: >-
            The currency code used by the Workspace to which this Recommendation
            belongs.
          nullable: true
          example: EUR
        currency_symbol:
          type: string
          description: >-
            The currency symbol used by the Workspace to which this
            Recommendation belongs.
          nullable: true
          example: EUR
      description: Recommendation model
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://console.vantage.sh/account/profile
          scopes:
            read: Grants read access
            write: Grants write access

````